Create layer diagrams from code

  • Artikel

To visualize your software system's high-level, logical architecture, create a layer diagram using Visual Studio Ultimate. To make sure that your code stays consistent with this design, validate your code with a layer diagram in Visual Studio Ultimate or Visual Studio Premium. You can create layer diagrams for Visual C# .NET and Visual Basic .NET projects.

What do you want to do?

  • Learn more about layer diagrams

  • Create a layer diagram

  • Create layers from artifacts

  • Manage links between layers and artifacts

  • Reverse-engineer existing dependencies

  • Edit layers and dependencies to show the intended design

  • Change how elements appear on the diagram

Learn more about layer diagrams

A layer diagram lets you organize Visual Studio solution items into logical, abstract groups called layers. You can use layers to describe major tasks that these artifacts perform or the system's major components. Each layer can contain other layers that describe more detailed tasks. You can also specify the intended or existing dependencies between layers. These dependencies, which are represented as arrows, show which layers can use or currently use the functionality represented by other layers. To maintain architectural control of the code, show the intended dependencies on the diagram and then validate the code against the diagram.

See:

Tip

When you create a layer diagram, you might consider creating dependency graphs to help you explore and understand the code. These graphs can help you discover clusters, patterns, natural layers, and dependencies in the code. This makes it easier for you to assign artifacts to layers. You might also use Architecture Explorer to explore namespaces and classes, which often correspond well to the existing layers. You can then use layer diagrams to help you update the code.

See:

Create a layer diagram

Before you create a layer diagram, make sure your solution has a modeling project. See Create UML Modeling Projects and Diagrams.

Important

Don't add, drag, or copy an existing layer diagram from a modeling project to another modeling project or to another place in the solution. This preserves the references from the original diagram, even if you change the diagram. This also prevents layer validation from working correctly and might cause other issues, such as missing elements or other errors when you try to open the diagram.

Instead, add a new layer diagram to the modeling project. Copy the elements from the source diagram to the new diagram. Save both the modeling project and the new layer diagram.

To add a new layer diagram to a modeling project

  1. On the Architecture menu, choose New Diagram.

  2. Under Templates, choose Layer Diagram.

  3. Name the diagram.

  4. In Add to Modeling Project, browse to and select an existing modeling project in your solution.

    -or-

    Choose Create a new modeling project to add a new modeling project to the solution.

    Note

    The layer diagram must exist inside a modeling project. However, you can link it to items anywhere in the solution.

  5. Make sure to save both the modeling project and the layer diagram.

Create layers from artifacts

You can create layers from Visual Studio solution items, such as projects, code files, namespaces, classes, and methods. This automatically creates links between layers and items, including them in the layer validation process.

You can also link layers to items that don't support validation, such as Word documents or PowerPoint presentations, so that you can associate a layer with specifications or plans. You can also link layers to files in projects that are shared across multiple apps, but the validation process won't include those layers, which appear with generic names such as "Layer 1" and "Layer 2".

To see if a linked item supports validation, open Layer Explorer and examine the Supports Validation property of the item. See Managing links to artifacts.

To

Follow these steps

Create a layer for a single artifact

  1. Drag the item onto the layer diagram from any of the following sources:

  2. Rename the layer to reflect the responsibilities of the associated code or artifacts.

Important

Dragging binary files to the layer diagram does not automatically add their references to modeling project. You must manually add the binary files that you want to validate to the modeling project.

To add binary files to the modeling project

  1. In Solution Explorer, open the shortcut menu for the modeling project, and then choose Add Existing Item.

  2. In the Add Existing Item dialog box, browse to the binary files, select them, and then choose OK.

    The binary files appear in the modeling project.

  3. In Solution Explorer, choose a binary file that you added, and then press F4 to open the Properties window.

  4. On each binary file, set the Build Action property to Validate.

Create a single layer for all selected artifacts

Drag all the artifacts to the layer diagram at the same time.

A layer appears on the diagram and is linked to all of the artifacts.

Create a layer for each selected artifact

Press and hold the SHIFT key while you drag all of the artifacts to the layer diagram at the same time.

Note

If you use the SHIFT key to select a range of items, release the key after you select the artifacts. Press and hold it again when you drag the artifacts to the diagram.

A layer for each artifact appears on the diagram and is linked to each artifact.

Add an artifact to a layer

Drag the artifact to the layer.

Create a new unlinked layer

In the Toolbox, expand the Layer Diagram section, and then drag a Layer to the layer diagram.

To add multiple layers, double-click the tool. When you are finished, choose the Pointer tool or press the ESC key.

- or -

Open the shortcut menu for the layer diagram, choose Add, and then choose Layer.

Create nested layers

Drag an existing layer onto another layer.

- or -

Open the shortcut menu for a layer, choose Add, and then choose Layer.

Create a new layer that contains two or more existing layers

Select the layers, open the shortcut menu for your selection, and then choose Group.

Change the color of a layer

Set its Color property to the color that you want.

Specify that artifacts associated with a layer must not belong to the specified namespaces

Type the namespaces in the layer's Forbidden Namespaces property. Use a semicolon (;) to separate the namespaces.

Specify that artifacts associated with a layer cannot depend on the specified namespaces

Type the namespaces in the layer's Forbidden Namespace Dependencies property. Use a semicolon (;) to separate the namespaces.

Specify that artifacts associated with a layer must belong to one of the specified namespaces

Type the namespace in the layer's Required Namespaces property. Use a semicolon (;) to separate the namespaces.

The number on a layer indicates the number of artifacts that are linked to the layer. However, when reading this number, remember the following:

  • If a layer links to an artifact that contains other artifacts, but the layer does not link directly to the other artifacts, then the number includes only the linked artifact. However, the other artifacts are included for analysis during layer validation.

    For example, if a layer is linked to a single namespace, then the number of linked artifacts is 1, even if the namespace contains classes. If the layer also has links to each class in the namespace, then the number will include the linked classes.

  • If a layer contains other layers that are linked to artifacts, then the container layer is also linked to those artifacts, even though the number on the container layer does not include those artifacts.

  1. On the layer diagram, open the shortcut menu for the layer, and then choose View Links.

    Layer Explorer shows the artifact links for the selected layer.

  2. Use the following tasks to manage these links:

To

In Layer Explorer

Delete the link between the layer and an artifact

Open the shortcut menu for the artifact link, and then choose Delete.

Move the link from one layer to another

Drag the artifact link to an existing layer on the diagram.

- or -

  1. Open the shortcut menu for the artifact link, and then choose Cut.

  2. On the layer diagram, open the shortcut menu for the layer, and then choose Paste.

Copy the link from one layer to another

  1. Open the shortcut menu for the artifact link, and then choose Copy.

  2. On the layer diagram, open the shortcut menu for the layer, and then choose Paste.

Create a new layer from an existing artifact link

Drag the artifact link to a blank area on the diagram.

Verify that a linked artifact supports validation against the layer diagram.

Look at the Supports Validation column for the artifact link.

Reverse-engineer existing dependencies

A dependency exists wherever an artifact that is associated with one layer has a reference to an artifact that is associated with another layer. For example, a class in one layer declares a variable that has a class in another layer. You can reverse-engineer existing dependencies for artifacts that are linked to layers on the diagram.

Note

Dependencies cannot be reverse-engineered for certain kinds of artifacts. For example, no dependencies will be reverse-engineered from or to a layer that is linked to a text file. To see which artifacts have dependencies that you can reverse-engineer, open the shortcut menu for one or multiple layers, and then choose View Links. In Layer Explorer, examine the Supports Validation column. Dependencies will not be reverse-engineered for artifacts for which this column shows False.

  • Select one or multiple layers, open the shortcut menu for a selected layer, and then choose Generate Dependencies.

Typically, you will see some dependencies that should not exist. You can edit these dependencies to align them with the intended design.

Edit layers and dependencies to show the intended design

To describe the changes that you plan to make to your system or the intended architecture, edit the layer diagram:

To

Perform these steps

Change or restrict the direction of a dependency

Set its Direction property.

Create new dependencies

Use the Dependency and Bidirectional Dependency tools.

To draw multiple dependencies, double-click the tool. When you are finished, choose the Pointer tool or press the ESC key.

Specify that artifacts associated with a layer cannot depend on the specified namespaces

Type the namespaces in the layer's Forbidden Namespace Dependencies property. Use a semicolon (;) to separate the namespaces.

Specify that artifacts associated with a layer must not belong to the specified namespaces

Type the namespaces in the layer's Forbidden Namespaces property. Use a semicolon (;) to separate the namespaces.

Specify that artifacts associated with a layer must belong to one of the specified namespaces

Type the namespace in the layer's Required Namespaces property. Use a semicolon (;) to separate the namespaces.

Change how elements appear on the diagram

You can change the size, shape, color, and position of layers or the color of dependencies by editing their properties.

See Also

Concepts

Visualize code