Peter Hilton - Speaking & training

Write one-sentence documentation comments

One of 97 Things Every Java Programmer Should Know

You’re probably either writing too many comments in your code, or none at all. Meanwhile, comments are amazingly useful, if they’re good, mainly because we spend more time reading code than writing it. This presentation gives specific actionable advice on how to write useful comments, while also starting a discussion about what it means to document code properly. (Talking about code comments always starts a discussion.)

Programmers don’t have access to enough good advice about how to write code. The craft suffers when software developers rely on too few voices in too few books. 97 Things Every Programmer Should Know (book, full text) improved on previous books by introducing specific advice from many practitioners. This presentation covers one of Peter Hilton’s published contributions from the follow-up book, 97 Things Every Java Programmer Should Know.


Share on TwitterShare on LinkedIn