C# and documentation, diagrams; Re-engineering

Question

C# and documentation, diagrams; Re-engineering

Markus Freitag 3,791

Hello,

I need to analyze an existing code, i saw that

/// <summary>
/// Base class for extending context. NOTE: <see cref="GroupContext"/> NOT IMPLEMENTED. Allows extending <see cref="IExtension"/> within extension assemblies.
/// </summary>
public abstract class ContextExtension : IContextExtension
{
    public LaneGroupExtension(IGroup p) : base(p) { }
}

[Obsolete("Use LaneGroupExtension instead.")]
IContextExtension Internal3{ get; }

Is there an overview on how to create documentation in VisualStudio2019? How the commands are? How to enable, how do they affect?
What is possible?

How can one recognize the software architecture? Re-engineering? I should somehow recognize the class context.
Maybe with VS2019 or other free tools?

Thanks for tips.

Greetings Markus

Accepted answer

0 additional answers

Your answer

Answer 1

Karen Payne MVP 35,586 Volunteer Moderator

Right click on a project using Visual Studio, select Show Type Dependencies Diagram to see code flow.

Documentation is on the original developer. So you can create a .md file via the following which can be installed via NuGet.

Bottom line for the code posted, unless it's documented and/or you can run thru code in the debugger you will need to determine what it does and why it implements the Interrace on your own.

Markus Freitag 3,791

Hello @Karen Payne MVP ,

Thanks for the response.

Is not work, however.
I make it.

PM> Install-Package Vsxmd -Version 1.4.5          
    Es wird versucht, Abhängigkeitsinformationen für das Paket "Vsxmd.1.4.5" bezüglich des Projekts "TCPServer" mit dem Ziel ".NETFramework,Version=v4.6.1" zu erfassen.  
    Das Erfassen von Abhängigkeitsinformationen hat 1,32 sec gedauert.  
Das Ausführen von NuGet-Aktionen hat 2,37 sec gedauert.  
Verstrichene Zeit: 00:00:04.0681901  
PM>

Successful installation message

Markus Freitag 3,791 Reputation points

2021-06-11T14:42:00.597+00:00
Right click on a project using Visual Studio, select Show Type Dependencies Diagram to see code flow.

Nothing appears. See my other comment.

/// <summary> /// Base class for extending context. NOTE: <see cref="GroupContext"/> NOT IMPLEMENTED. Allows extending <see cref="IExtension"/> within extension assemblies. /// </summary>

Is there an overview of the messages, options and how to use them?
Karen Payne MVP 35,586 Reputation points Volunteer Moderator

2021-06-11T23:32:12.947+00:00

You need to setup xml documentation XML documentation file under project properties, Build tab. Then write comments. For Framework 4.8 the .md file will reside in the debug folder while .NET Core in the root folder of the project.
Karen Payne MVP 35,586 Reputation points Volunteer Moderator

2021-06-11T23:33:07.033+00:00

I'm using Enterprise edition, perhaps it's not available in pro or community editions
Markus Freitag 3,791 Reputation points

2021-06-12T19:03:50.603+00:00

Hello @Karen Payne MVP ,

I'm sorry, it doesn't work. Do you have another tip?
Another tool?

Thanks in advance.
Timon Yang-MSFT 9,606 Reputation points

2021-06-15T06:58:03.177+00:00

If you want to use architecture and modeling tools, you need to install related components.
Architecture menu not visible
In addition, this feature does have distinct levels of support in different versions of Visual Studio.
Edition support for architecture and modeling tools
Markus Freitag 3,791 Reputation points

2021-06-15T19:22:53.067+00:00

Thank you for your answer. This is how it looks.

Maybe it doesn't work with the Professional version.

Do you know the differences?

If not possible
How do I completely delete a tool installed by Nutget?
Karen Payne MVP 35,586 Reputation points Volunteer Moderator

2021-06-15T20:48:40.917+00:00

To remove packages for prior to .NET Core, select the installed package in installed packages window and click uninstall. You may get that the package cannot be removed because another package depends on it so try another package first. While the same works for .NET Core you can open the project file and remove package entries and save the project file.
Timon Yang-MSFT 9,606 Reputation points

2021-06-16T06:42:49.267+00:00

Well, I tested it with other versions, it seems that this option is indeed limited to the enterprise version.

Share via

C# and documentation, diagrams; Re-engineering

0 additional answers

Your answer