question

MarkusFreitag-0088 avatar image
0 Votes"
MarkusFreitag-0088 asked TimonYang-MSFT commented

C# and documentation, diagrams; Re-engineering

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

dotnet-csharp
5 |1600 characters needed characters left characters exceeded

Up to 10 attachments (including images) can be used with a maximum of 3.0 MiB each and 30.0 MiB total.

1 Answer

karenpayneoregon avatar image
1 Vote"
karenpayneoregon answered TimonYang-MSFT commented

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

104352-figure1.png

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.




figure1.png (38.8 KiB)
· 9
5 |1600 characters needed characters left characters exceeded

Up to 10 attachments (including images) can be used with a maximum of 3.0 MiB each and 30.0 MiB total.

Hello @karenpayneoregon,

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

104816-nothing-to-see-it.png







0 Votes 0 ·

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.

1 Vote 1 ·


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?

0 Votes 0 ·

I'm using Enterprise edition, perhaps it's not available in pro or community editions

1 Vote 1 ·

Hello @karenpayneoregon,

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

Thanks in advance.

0 Votes 0 ·
Show more comments