DEV Community

Discussion on: All Remote: Documenting your code is now essential. There is a better way. (Part 4)

wroth profile image
Charles Roth

80/20 rule for documentation:

1 Put in a header comment for a class (or equivalent metaphor depending on your language) explaining WHY the class exists. What is its purpose in life?

2 Good naming of methods (functions, whatever).

3 Small methods (functions).

Perhaps CodeStream could offer enforcement of some of the above? (OK, hard to enforce "good"! :-) )