do you comment?

Started by
209 comments, last by Gaiiden 19 years, 10 months ago
quote:Original post by Anonymous Poster
Hello,

The examples in this article are terrible. Comments in code are important because they answer the question "why are we doing it like this." The article seems to encourage people to also document "what" (increment variable, initialize fields, etc.) and "how" (we call this routine to that...) which is not only useless but dangerous and stupid too. If you have trouble understanding what a piece of code does or how it does it, it's time to fix up the code, not comment it!

If you use routine and/or file banners, please make sure they're terse and to the point. After all, you're a programmer, not an ASCII artist.

---pje


And you're a necroer. This thread is like OLD, don't post in it.

--
You're Welcome,
Rick Wong
- Google | Google for GameDev.net | GameDev.net's DirectX FAQ. (not as cool as the Graphics and Theory FAQ)

[edited by - Pipo DeClown on June 11, 2004 10:12:15 AM]

This topic is closed to new replies.

Advertisement