1
I would like to document an api for C#, in the style javadoc. Is there any way to memorize/comment the code so that documentation of the types and their members is generated automatically?
C# gives native support to this, or some external tool is required?
@bigown agree with the closing of the question as it was - now I think about improve it to fit the format of the site. I believe that automatic XML documentation is useful for many people and that it can be solved in a unique and direct way as supported by the platform.
– Oralista de Sistemas
@Renan its edition was surgical.
– lemoce
but it is no longer "based on opinions"
– Rovann Linhalis
Now I think it’s duplicate, let me find.
– Maniero
@bigown I looked for one to mark this as duplicate and did not find - but if there is one it is good that we keep a pointer to canonical answer.
– Oralista de Sistemas
@bigown would be that https://answall.com/questions/693/existe-alguma-ferramenta-que-gere-documentação-similar-a-msdn ?
– lemoce
@lemoce that seems appropriate.
– Oralista de Sistemas
@Not lemoce, it has nothing to do.
– perozzo
I found this https://answall.com/q/78552/101 but it has some more specific still, it is difficult to find, but I know I answered. I think there’s a dup de dup in there
– Maniero
@lemoce Anyway... put XML comments on your types and members. Try writing three bars (
///) on top of a method that has return and parameters, for example. Then compile the code with the option/docthat what Visual Studio generates a file with the documentation in the same directory as the DLL’s.– Oralista de Sistemas
@Bigown there is another technology widely used for this, which is not in any link of these that was mentioned. Why put the question as pending?
– perozzo
@lemoce is using ASP.NET Core Web Api?
– perozzo
@Perozzo’s initial version of the question asked what the best tool, what made her opinionated. The current version is more useful, but is similar to questions asked before. If no similar question asked before have the tool you have in mind, you can answer on them.
– Oralista de Sistemas
@Renan The questions asked before, do not refer to a C API#.
– perozzo
@Perozzo answers there then, including I merged the two questions that already existed.
– Maniero
@Renan I think I found the two best. This is related: https://answall.com/q/29709/101
– Maniero
@Perozzo I’m using Monodevelop, but I’ll take a look at those answers. Maybe I’ll use doxygen for that, but I’ll still evaluate.
– lemoce