Defining Programming Standards   
for Professional Programmers 
  

         

Home

Contents

1: Standards

2: Psychological Factors

3: General Principles

4: Commenting

5: Naming

6: Code Layout

7: File Layout

8: Language Usage

9: Data Usage

10: Programming Usage

11: Implementing Standards

A: Example Standard

B: References

C: Glossary

Syque

About

Share this page:

Google
C Style
syque.com
Web

 

 

Books and
more at:

USA:

In association with amazon.com

UK:

In Association with Amazon.co.uk

Canada:

In Association with amazon.ca

 

 

Part 2 : Commenting and Naming

CHAPTER 4 : Commenting
CHAPTER 5 : Naming
 

PART 3 : LAYOUT

<-- Prev page | Next page -->

<-- Prev part | Next part -->

 

The comments around the code and the names of identifiers used within the code together constitute the readable English in a program. Individually and collectively they explain to the reader what is happening. The comments allow explanation around a point, setting the context and giving reasons for what is about to happen or has just happened. The identifiers are more succinct, being constrained to being a part of the code, but which when well named can make the code read clearly and make its operation and purpose more understandable. It is thus well worth the additional effort required to make the code and comments literally more readable.

 

<-- Prev page | Next page -->

 

 

  © Syque 1995-2013

Massive Content -- Maximum Speed