目标

指导C＋＋程序的开发

程序头

程序头格式

所有程序都应从一个描述性的开头开始

/********************************************************************/

/*Program Assignment：程序号                                         */

/*Name：            你的姓名                                       */

/*Date：             程序开发开始日期                               */

/*Description：       对程序功能的一个简单描述                       */

/********************************************************************/

清单内容

内容距离

一份清单内容的概要

/********************************************************************/

/*Listing Contents （清单内容）：                                       */

/*    Reuse Instruction （重用指导）                                   */

/*    Includes （包括）                                              */

/*    Class Declararions （类说明）                                    */

/*        CData                                                     */

/*        Aset                                                      */

/*    Source Code in C （用C编写的源代码）： \classes\Cdata.cpp:         */

/*        Cdata                                                     */

/*        Cdata()                                                    */

/*        Empty()                                                   */

/********************************************************************/

重用指导

示例

描述如何使用该程序。提供说明格式、参数值和类型以及参数范围；

提供对非法值、溢出条件或其他潜在的有可能引起非正常操作的条件等方面的警告。

/********************************************************************/

/*Reuse Instruction （重用指导）                                      */

/*    Int Printline(char *line_of_character)                               */

/*    目的：画线，’line_of_character’，位于同一打印行                  */

/*    限制：线长最多为LINE_LENGTH                               */

/*    Return：0 if 打印机未准备好                                    */

/*           else 1                                                  */

/********************************************************************/

标识符

标识符示例

所有变量、函数名、常数以及其它标识符都是用带有描述性的名称。避免缩写形式或仅有一个字母的变量名。

int number_of_students                                /*此标识符好*/

int x4,j,ftave                                         /*此标识符不好*/

注释

好的注释

不好的注释

程序主体

示例

编码、文档要充分，以帮助读者理解其功能；

注释及应说明编码的目的，也应说明编码的行为；

对变量声明进行注释，指出说明该变量的目的。

If (record_count>limit)                      /*是否所有的记录都处理了*/

If (record_count>limit)                 /*检查record_count是否超过限制*/

程序主体前应有一段注释来描述由以下部分所作的处理。

/********************************************************************/

/*以下程序部分将检察署驻“grades”的内容，并将计算班级成绩的平均值。 */

/********************************************************************/

空白区域

为了增加程序的可读性，写程序时应留出一定的空间；

每个程序结构之间至少有一空行将它们隔开。

缩进

缩进示例

不同级别的括号之间应该有缩进；

每一个起始括号和终止括号应单独占一行。

While (miss_distance > threshold)

{

success_code=move_robot(target_location);

if (success_code==MOVE_FAILED)

{

    pringf(“The robot move has failed.\n”)

}

}

大写

大写示例

所有定义应大写；

所有其它标识符及保留值均应小写；

对用户的输出信息可以大、小写相混合，以便用户清晰明了。

#define DEFAULT_NUMBER_OF_STUDENTS 15

int class_size=DEFAULT_NUMBER_OF_STUDENTS;