3 ms·
Don't load header files with documentation comments. Put them in the implementation. I don't see where the trouble is in properly documenting your code within
by kevin_thibedeau 8y ago
Don't load header files with documentation comments. Put them in the implementation.
I don't see where the trouble is in properly documenting your code within the code. That isn't any where near as intrusive as literate programming. On an active code base nobody is going to keep external docs up to date without a taskmaster to force the issue.
Open source code bases are often a poor example of good coding practices. 1000's of lines can go by with nary a comment. Everybody's so leet they don't need them? That's great if you are the principal author and know (or knew) what everything did at one time. Not so great in a commercial setting with a fluid developer base where the noobs need to know what's going on without reading every piece of code.
- jcelerier 8y ago> Don't load header files with documentation comments. Put them in the implementation. no, that's terrible. How do you do when you don't want to install the source of every lib you use ?
- kevin_thibedeau 8y agoYou read the generated docs or get the source.