Why do I need to use these nasty comments in C# / .Net code? -


i'm building application , 1 of requirements use comments one:

/// <summary> /// creates new client. /// </summary> /// <param name="uri">the uri.</param> /// <param name="param">the param.</param> /// <returns></returns> 

i understand it's easy various kind of tools generate docs based on these xmls. decreases code readability, , that's we, humans, trying achieve.

could approach replaced other technique in .net? , what's better way improve code readability , cleanness?

that information should pop on visual studio when uses intellisense while going through methods. save time since whoever using code not need go code (thus meaning not need expose of code) , see other comments have written.

i think documentation, when kept short , point, never bad thing , not affect code readability.


Comments

Popular posts from this blog

Detect support for Shoutcast ICY MP3 without navigator.userAgent in Firefox? -

web - SVG not rendering properly in Firefox -

java - JavaFX 2 slider labelFormatter not being used -