c语言编码规范.ppt

c语言编码规范.ppt编码标准

*
第一局部 前言
Preface

*
为什么要这么做？
书写良好的代码更容易阅读
容易阅读的代码才容易被理解
容易被理解的代码才安康
编程风格表达了程序员对语言的理解水平
求职：好************************/
注意：红色局部为必填局部，缺填红色局部可能导致作业无法得到批阅
注释开场
注释完毕

*
/****************************************************\
作者信息：
姓名：张三 学号：06123456 班级：计科0601班 学院：计算机
Email: ******@123 ：51689999
版权声明：
版权由张三所有，除教师外，未经允许不得拷贝本人作业
模块名称:
第一个模块
摘要:
本模块是我的第一个C语言作业，实现了一些简单的功能
其它说明:
　　无
模块历史:
　　张三于2006年9月20日创立本模块，
　　张三于2006年9月25日修改本模块，email: 同上
修改原因：增加了一个输出正方形的函数
\****************************************************/
#include “〞
#include “〞
/**********************\
main函数说明
\**********************/
main()
{
　　　…..
}
模块说明例如:


*
English Version
/****************************************************\
Author Info:
Name: Author ID: Class: School:
Email: Tel.
Copyright (c) 2005 NJTU
Module Name:
An unabbreviated name for the module (not the filename)
Abstract:
Description of what this module does
Notes:
[Optional] Additional notes about this module - things that may help
the reader of this code later on. Examples are: algorithm description,
special case conditions, references, etc.
History:
Created on mm/dd/yyyy by email-name
Modified on mm/dd/yyyy by email-name
[Optional] history description
\****************************************************/

*
2. 函数说明标准
Function Specification

*
关于函数说明
对于作业中程序的任何一个函数，包括main函数，都需要写出函数的说明
一个良好的编程习惯：
写任何一个函数以前，第一步工作就是先把函数说明写出来，而不是直接先写代码

*
函数说明标准
/***********************************************\
函数名称:
写出函数的名称
功能描述:
描述出函数具有的功能
函数参数:
输入输出参数说明，对每个参数都需要作出仔细说明
返回值:
返回值说明，或者标明无回值
模块历史:
谁于某年某月某日创立本模块，创立人email
谁于某年某月某日修改本模块，修改人email
修改原因：可有可无，根据需要添加
\**********************************************/

*
例子
/**********************************************************************\
函数名称:
main
功能描述:
输出 Hello world!
函数参数: