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

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

enter image description here

UPDATE # 1

Now a very strange idea occurred to me, for my task, I just need documentation for some DLL in different languages ​​and that's it. I think to write some software that will go up to the prebuild event and put up wherever documentation is needed for the studio to compile an XML file. And at the postbuild event will be raised software, which 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 dock itself will have to be edited).

    1 answer 1

    I do not want to upset, but XML-комментарии are 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 a Visual Studio extension called GhostDoc , which allows you to automate and standardize some routine actions and operations.

    • Thanks for the extension, not bad! :-) Zaapdeytil post, came up with a good decision - Mark Khromov
    • 2
      If you noticed, there are both paid and free versions, but even free ones allow you to override the comments set by the manufacturer to your own taste and style, which saves time in the future) - sp7