Documentation of C# projects in multiple languages in VisualStudio

It is necessary to document all the code in the project, so that when using the method, the studio suggests everything about it that is possible. The only thing I could find for my situation is the XML documentation, for .csproj. But, as far as I understand, it turns out not too nice and very cumbersome in the source code, especially if you do it via xml: lang= "LANG_ID".

What is the best and most correct approach for documenting the code? In the end as a result, of course, I would like to achieve such a result as y .NET out of the box.

enter a description of the image here

UPDATE #1

Now I came up with a very strange idea, for my task, I just need documentation for some DLL in different languages and that's it. I'm thinking of writing some software that will be raised at the prebuild event and put up documentation wherever you need it, so that the studio can build an XML file. And on the postbuild event will be raised Software that will clear all the exposed lines. This approach allows you to make the code clean from the docks and fully automate the process (only the doc itself will have to be edited).

Author: edem, 2017-06-28

1 answers

I don't want to upset you, but XML-комментарии, this is the only thing that will allow you to achieve the desired result. And in order for the process of writing them not to be so "painful" and boring, I can recommend an extension for Visual Studio called GhostDoc, which allows you to automate and standardize some routine actions and operations.

 4
Author: sp7, 2017-06-28 06:53:33