Timeline for Why are /// comment blocks important?
Current License: CC BY-SA 2.5
9 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Aug 27, 2024 at 8:35 | comment | added | R. Schmitz | Update in 2024: Use these primarily on the public types and members of your library. For private stuff, they are more of a band-aid, for things that are too complicated. Try to make it not complicated first, though - good practices like Single Responsibility Principle help with this. | |
| Nov 21, 2018 at 8:44 | comment | added | Jeroen van Langen | They are usefull, but they make the current class very unreadable. I wish there was another way which doesn't cluttering the code. | |
| Mar 9, 2011 at 5:44 | comment | added | Benjol | Just one thing to add, these comments aren't compiled into the dll, you have to deliver the associated xml file with your dll. | |
| Sep 23, 2010 at 19:56 | vote | accept | Rachel | ||
| Sep 21, 2010 at 17:19 | comment | added | JYelton | Because this answer is already the best choice I will just add my comment: When I found out that the summary is used for intellisense, and my projects grew to their current size, I was very glad to have found this feature. Remembering what my methods and classes are for was becoming a huge challenge, and documenting code via this mechanism greatly simplified things, allowing me to focus on new code and resusability instead of trying to remember what was done months ago. | |
| Sep 21, 2010 at 17:08 | comment | added | ShdNx | Also if you're using Visual Studio and begin a line with /// just before a class, method or field declaration, VS will generate the XML documentation structure for you - you just have to fill it in. I agree that it takes up a lot of space of your screen, but it's a worthy compromise I'd say. Also, F# has some better support for it (e.g. you don't have to use <summary> and </summary> since they are 'assumed'). | |
| Sep 21, 2010 at 14:43 | comment | added | Walter | +1 Absolutely use them. You would be surprised at how useful it is to have them if you ever reuse your components and have all that great documentation available in intellisense. | |
| Sep 21, 2010 at 13:47 | history | edited | Ryan Hayes | CC BY-SA 2.5 | added 1 characters in body |
| Sep 21, 2010 at 13:42 | history | answered | Ryan Hayes | CC BY-SA 2.5 |