C语言头文件编程规范..docx

C语言头文件编程规范


/*****************************************************************************/
/*
/* 版权所有(C)2012, 于林峰(九江学院)
/*
/* 文件名称: 头文件
/* 文件标识:
/* 内容摘要: 线性链表的"顺序"表示和实现
/* 其它说明:
/* 当前版本:
/* 作者: 于林峰
/* 完成日期: 2012年07月02日
/* ---------------------------------------------------------------------------
/* 修改记录1:// 修改历史记录,包括修改日期、修改者及修改内容
/* 修改日期:2012年10月02日
/* 版本号:
/* 修改人:于林峰
/* 修改内容:头文件的包含、函数结果状态码、
/*
/* 修改记录2:…
/*
/*****************************************************************************/
#ifndef _UNIHEADER_H_
#define _UNIHEADER_H_
#pragma once
#include <>
#include <> // eof()
#include <>
#include <> // INT_MAX 等
#include <> // malloc() 等
#include <> // floor(), ceil(), abs()
#include <> // exit()
#include <> // EOF(=^Z 或 F6), NULL
#include <> // atoi() 等
#include <>
/*****************************************************************************/
/* */
/* 标识符命名基本规则(根据中兴公司 C/C++ 编程规范) */
/* */
/* ------------------------------------------------------------------------- */
/* */
/* 1. 标识符要采用英文单词或其组合,便于记忆和阅读*/
/* 切忌使用汉语拼音来命名。*/
/* */
/* 说明:标识符应当直观且可以拼读,可望文知义,避免使人产生误解。*/
/* 程序中的英文单词一般不要太复杂,用词应当准确。*/
/* */
/* 2. 标识符只能由26个英文字母,10个数字,及下划线的一个子集来组成, */
/* 并严格禁止使用连续的下划线, */
/* 下划线也不能出现在标识符头或结尾(预编译开关除外)。*/
/* */
/* 说明:这样做的目的是为了使程序易读。*/
/* 因为 variable_name 和 variable__name 很难区分, */
/* 下划线符号'_'若出现在标识符头或结尾, */
/* 容易与不带下划线'_'的标识符混淆。*/
/* */
/* 3. 标识符的命名应当符合"min-length && max-information"原则。*/
/* */
/* 说明:较短的单词可通过去掉"元音"形成缩写, */
/* 较长的单词可取单词的头几个字母形成缩写, */
/* 一些单词有大家公认的缩写,常用单词


的缩写必须统一。*/
/* 协议中的单词的缩写与协议保持一致。*/
/* 对于某个系统使用的专用缩写应该在某处做
统一说明。*/
/* */
/* 正例:如下单词的缩写能够被大家认可: */
/* temp 可缩写为 tmp */
/* flag 可缩写为 flg */
/* statistic 可缩写为 stat */
/* increment 可缩写为 inc */
/* message 可缩写为 msg */
/* */
/* 规定的常用缩写如下: */