Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

It's a great article.

For myself, and my approach, I'm always a bit leery of "hard and fast" rules. I prefer a heuristic approach to almost everything that I do. Also, I've found that code comments are only part of the mix. As the article indicates, the code, itself, should be written in a clear fashion, and supporting materials (which can include seminars, tutorials, examples, unit tests, and test harnesses) are an important ingredient.

I wrote my own approach to documentation in this post: https://littlegreenviper.com/miscellany/leaving-a-legacy/

It's a long read. I don't think many people really give it much of a gander.



Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: