Proper XML documentation?

[Tom Peters]

Hi, it’s Tom Peters!

It would be nice if you could find an easy way to generate proper XML documentation. I’m saying this because you’re documenting like this:

1 2 3 4

/// This method does this and that void DoThisAndThat() { }

If I type type the method “DoThisAndThat” somewhere in code and highlight it, it won’t show the documentation (This method does this and that)

But, this will do:

1 2 3 4 5

/// <summary> /// This method does this and that /// </summary> void DoThisAndThat() { }

It’d be nice if you could document your source this way.

If you’re using VS, just type “///” and it will auto-generate the XML header for you (don’t know about MD though)

– TP

[Tom Peters]

The IDE would also auto-generate tags for the return type, and input parameters not just the summary tag.

[Gavalakis]

I don’t really use VS and while I don’t either use MD, i know that in MD this shows up corrently.
Furthermore Doxygen can create documentation with this comment type and that’s why I opted going this way since it’s a bit cleaner. In any case, I will probably do this in the future for the shake of VS.

Join us on Discord: https://discord.gg/97q2Rjh

[grofit]

For shame… Visual Studio + Resharper is the best thing ever for any developer 😉

[Author]

Posts