DEV Community

Discussion on: Clean Code in C# Part 3 Comments

Collapse
 
jayjeckel profile image
Jay Jeckel • Edited

You say you've never used external generated docs, but I'd bet you've read Microsoft's dotnet docs and those are autogenerated from the source code and its documentation comments.

To each their own, but in the decade I've been building .Net libraries and applications, well written documentation has been extremely useful, both as an asset for clients and as a knowledge store for future devs when brought onto a project.

My main point is that documentation comments and code comments aren't the same thing. The idea proposed by Uncle Bob and the like, that comments are bad and should be replaced with self describing code, applies to code comments, not documentation comments, because documentation comments aren't for people reading the code, they are for people reading the docs.

Thread Thread
 
caiocesar profile image
Caio Cesar

Hey Jay, makes sense for people reading the documents in applications that exposes the documentation to have comments in classes and methods. In these cases for external documents, I would consider them as part of the non-functional requirements.