Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Best aproach for commenting source code to understand the workflow of the whole project? [closed]

in private and in companies it is over and over again a problem that I or we developers comment in fact our code but generally nobody knows exactly how the code of the whole project works together. When I write my own code and the project is getting bigger I sometimes have this problem too. Although I write tons of comments, after 3 months you don't know what the whole thing exactly does, that means how the different methods and classes work together.
How do you solve this in your company or in private (if there is just marginal project development and no requirements specification). Or do you have always such a good project development with contract document and requirements specification that you don't have to worry about that?

like image 917
Bevor Avatar asked Jul 15 '11 08:07

Bevor


People also ask

How do you comment out code on Go?

Comments in Go begin with a set of forward slashes ( // ) and continue to the end of the line. It is idiomatic to have a white space after the set of forward slashes.

What does it mean to comment code?

In computer programming, a comment is a programmer-readable explanation or annotation in the source code of a computer program. They are added with the purpose of making the source code easier for humans to understand, and are generally ignored by compilers and interpreters.


1 Answers

Code complete can explain the solution to your problem better than I ever could.

like image 146
Tom Squires Avatar answered Oct 18 '22 13:10

Tom Squires