How important is it to use <summary> in methods and classes?
How shocking is this at the development level?
What is the good side and the bad side of its use?
Summary in classes and methods [duplicate]
2
asked by anonymous 05.10.2015 / 19:18
1 answer
2
How important is it to use
<summary>in methods and classes?
Not only document your code elements, but also serve as help when using IntelliSense ( Ctrl + Shift of <summary> appears there).
<summary> is just one of the tags that can be used for documentation. Here is a list of other tags that you can use .
How shocking is this at the development level?
It helps a lot, essentially if you're writing a component that is common to several classes of your system, such as DLL's.
What's the good side and the bad side of your use?
I do not know if there's a bad side. There are, yes, many good sides.
It is an organized and standardized form of documentation, which is used by both the programmer and the IDE. If well structured, can even be used to generate automatic documentation for your code .
05.10.2015 / 19:21