4 ms·
Given the amount guys like this[1] that work at Microsoft love XML, it sounds pretty reasonable. Actually liking the XML docblocks though is taking it a bit too
by yareally 13y ago
Given the amount guys like this[1] that work at Microsoft love XML, it sounds pretty reasonable. Actually liking the XML docblocks though is taking it a bit too far. There's a lot of things I dislike about Java, but one thing they got right² (and almost everyone else used after) is their documentation blocks. When using Visual Studio I have to make the syntax color for XML elements of the blocks I generate super contrasting (usually really dark) with the documentation inside just to read it without making my head hurt.
> During the years I’ve seen a lot of different ways of commenting code – some good and some bad. My personal favourite way of commenting code is by using the XML comment feature of C# and VB.NET, but the important part of commenting code is not how you do it, but what you write in them.
[1] http://madskristensen.net/post/The-what-why-and-how-of-XML-code-comments.aspx http://madskristensen.net/post/The-what-why-and-how-of-XML-c...
² Java may not be the first, but it's the first language I saw to use that style