2
How important the use of <summary> in methods and classes?
How impactful this is at the level of development?
Which is the good side and which is the bad side of its use?
1 answer
2
How important the use of
<summary>in methods and classes?
Not only document your code elements, but also serve as help when using Intellisense (Ctrl + Shift + Space, the description of <summary> appears there).
<summary> is just one of the tags which can be used for documentation. Here is a list of other tags that can be used.
How impactful this is at the level of development?
It helps a lot, essentially if you are writing a component that is common to various classes of your system such as DLL’s, for example.
Which is the good side and which is the bad side of its use?
I don’t 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 of your code.
Browser other questions tagged c# .net documentation summary
You are not signed in. Login or sign up in order to post.