Моделирование и анализ кода

Часто разработчикам программного обеспечения приходится работать с исходным кодом, базовая архитектура которого неизвестна по той причине, что код был либо написан другим разработчиком или был написан настолько давно, что его создатели совершенно не помнят, как он работает. Вторым распространенным случаем является необходимость понять содержимое библиотеки, доступной исключительно в двоичном формате. В Visual C# имеются следующие средства, призванные помочь в моделировании, анализе и понимании типов и отношений типов в исходном коде и двоичных сборках:

• Конструктор классов для визуального представления наследования и связей между типами.

• Обозреватель объектов для анализа типов, методов и событий, экспортированных сборками .NET Framework, а также исходных библиотек DLL с COM-объектами.

• Метаданные в качестве источника для просмотра сведений о типах в управляемых сборках, как если бы это был исходный код в собственном проекте.

В дополнение к средствам, перечисленным выше, система Visual Studio Team System включает средство анализа управляемого кода, с помощью которого можно проверить код на наличие разнообразных потенциальных проблем.

Конструктор классов

Конструктор классов представляет собой графическое средство для визуального моделирования связей между типами в приложении или компоненте; конструктор классов можно использовать для создания новых типов и оптимизации или удаления существующих. На следующем рисунке показан простой класс.

To add a class diagram to a project, click Add New Item on the Project menu, and then click Add Class Diagram.

--------

Чтобы добавить схему классов в проект, в меню Проект щелкните Добавить новый элемент, а затем щелкните Добавить схему классов.

Object Browser

The Object Browser enables you to view type information in both native and managed DLLs, including COM objects. Although the information you see in the Object Browser is similar to what you see in Class View, you can use Object Browser to examine any DLL on your system, not only the ones referenced in your own project. In addition, Object Browser also displays XML documentation comments for the selected type. The following illustration shows how Object Browser displays type information in binary files.

Обозреватель объектов

Обозреватель объектов позволяет просматривать сведения о типах как в собственных, так и в управляемых библиотеках DLL, включая COM-объекты. В то время как сведения, отображаемые в обозревателе объектов аналогичны сведениям в представлении класса, при помощи обозревателя объектов можно проанализировать любую библиотеку DLL в системе, а не только библиотеки, на которые имеются ссылки в проекте. Кроме того, в обозревателе объектов также отображаются комментарии XML-документации для выбранного типа. На следующем рисунке показано, как в обозревателе объектов отображаются сведения о типах в двоичных файлах.

Metadata as Source:

The Metadata As Source feature enables you to view type information for classes in managed assemblies as if it were source code in your own project. This is a convenient way to view the signatures for all the public methods in a class at a glance when you do not have access to the actual source code.

For example, if you enter the statement System.Console.WriteLine() in the code editor, place the insertion point within Console and then right-click and select Go To Definition, you will see what looks like a source code file containing the declaration of the Console class. This declaration is constructed from the metadata in the assembly using Reflection, and although it does not expose the implementation of any methods, it does show any XML documentation comments that are present.

You can also use the Metadata As Source feature by selecting a managed type in the Object Browser, and clicking Code Definition Window on the View menu.

Code Analysis for Managed Code

The code analysis for managed code tool analyzes managed assemblies and reports information such as potential security problems, and violations of the programming and design rules set forth in the Microsoft .NET Framework Design Guidelines. This information is presented as warnings. You access the tool in the Project Designer by right-clicking Properties in Solution Explorer, and selecting Open.