Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com
Answertopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

The GNU C Programming Tutorial - Comments and style

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.

 
 
  Published under free license. Design by Interspire