Node:Comments and style, Next:, Previous:Formatting code, Up:Style

Comments and style

Comments are crucial for other programmers trying to understand your code. Every program should start with a comment saying briefly what it is for. Example: fmt - filter for simple filling of text. Similarly, you should put a comment on each function saying what the function does, what sort of arguments it takes, what the possible values of arguments mean, and what they are used for.

Please write all comments in a GNU program in English, because English is the one language that nearly all programmers in all countries can read.