编程规范.pdf

编程规范― PT Lab 2001 年 1 月














编程规范


















清华大学计算机系网络所
版权所有不得复制



1
编程规范― PT Lab 2001 年 1 月
1. 说明
PT 实验室承担的 863 重点项目
IPTEST 中。本文档的目的在于保证测试仪软件编写的质量,以避免在开发和调试过程中出
现不必要的麻烦。
2
编程规范― PT Lab 2001 年 1 月
2. 文件头的编写规范
每个文件开头部分都应当包括:文件标题(Title );版权说明(Copyright);修改记录
(Modification History)。
(1)Title 中包括文件的名称和文件的简单说明。Title 应该在一行内完成。
(2)Copyright 包括一个版权说明,长度为一行。
例如,在本项目中,版权说明使用:
/* Copyright (c) 2000 by Tsinghua Univ., Beijing, . */
(3)Modification History
记录文件修改的过程,只记录最主要的修改。当书写新的函数模块时,只需要使用
形如“add func1()”这样的说明;如果后面又对函数中的算法进行了修改,需要指出修改
的具体位置和修改方法。
Modification History 的具体格式为:
<修改时间>,<修改人>,<修改动作>
如:
19apr2000,by Mike, added routines myfunc()
一个文件头的具体范例如下:
/* - foo subroutine library */
/* Copyright (c) 2000 by Tsinghua Univ., Beijing, . */
/*
modification history
--------------------
15sep1999, by nfs, added defines MAX_FOOS and MIN_FATS.
15feb2000, by dnw,added routines fooGet() and fooPut();
added check for invalid index in fooFind().
10feb2000, by dnw,written.
*/
3
编程规范― PT Lab 2001 年 1 月
3. C 代码书写规范
C 程序的书写范例:见
C Module Layout
C Module Layout 包括以下内容:
(1)General Module Documentation:对整个模块目的和功能的完整描述注释。
内部包括 DESCRIPTION 和 INCLUDE FILES 两部分。INCLUDE FILES 后列出所
包含的头文件。
(2)Includes:包含的头文件说明。
(3)Typedefs:类型定义。
(4)Globals:全局变量定义。只有那些可以在本模块外访问的变量才定义为全局变量。
(5)Locals:局部变量定义。那些只希望在本模块内访问的变量定义为局部变量。
(6)Forward Declarations:声明将在本模块内使用,而且在本模块中实现的函数。
一个具体的范例如下:

/* - foo subroutine library */
/* Copyright (c) 2000 by Tsinghua Univ., Beijing, . */
/*
modification history
--------------------
15sep1999, by Mike, added defines MAX_FOOS and MIN_FATS.
15feb2000, by Tom, added routines fooGet() and fooPut();
added check for invalid index in fooFind().
10feb2000, by John, written.
*/
/*
DESCRIPTION
This module is an example of the W