Quantcast
Channel: In what stage of development should comments be written? - Software Engineering Stack Exchange
Browsing latest articles
Browse All 8 View Live

Answer by jmoreno for In what stage of development should comments be written?

Comments can be written at any stage, comments SHOULD be written when you believe the code needs explanation and you know that you understand it.Believing the code needs explanation should almost...

View Article



Answer by 9000 for In what stage of development should comments be written?

Most often I write comments before and instead of code. This way I lay out a plan of the future code in high-level terms.Then, I add code that the comments suggest. Comments describe what and why is...

View Article

Answer by milton for In what stage of development should comments be written?

I'd rather suggest anyone writing comments from the beginning of development, since the rationales and the context are fresher in the mind. This will save you a considerable maintenance effort, since...

View Article

Answer by Maximus Minimus for In what stage of development should comments be...

Write comments as you write the code. They're there for your benefit as well as the benefit of anyone who may be subsequently reading the code.You've got things half right when you talk about "explain...

View Article

Answer by Robert Harvey for In what stage of development should comments be...

Code should be self-describing, whenever possible. In other words, if you write clear code, you will need fewer comments. Comments should include:A general description of the class/method and what it...

View Article


Answer by Bart van Ingen Schenau for In what stage of development should...

Ideally, comments should be written at the same time as the code.In the real world, those comments are not nearly as often as needed actually written, so if you stumble across a piece of code that, in...

View Article

Answer by FrustratedWithFormsDesigner for In what stage of development should...

Your method will work great IFFevery piece of code you write gets thoroughly debugged and you have many passes through it to comment it. Hopefully, you will one day write more code that works fine...

View Article

In what stage of development should comments be written?

I'm a student working an internship at a larger company, writing small business apps in C#. I've noticed that I don't comment my code as I write it. Rather, I comment my code when I'm in the debugging...

View Article

Browsing latest articles
Browse All 8 View Live




Latest Images