通用函数说明字段一览

上一篇 / 下一篇  2012-12-22 20:46:49 / 个人分类:后端开发与编程

   一般来说,以下字段可以作为函数的通用说明头:

 

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

Function Name:  XXX //函数/过程名称

Description: XXX  //函数/过程目的

Calls:  XXX       //被本函数调用的其他函数

Called by:  XXX   //本函数会被哪些函数调用

Assumption:  XXX  //假设

Effect:  XX       //影响

Input:  XX        //输入参数

Output:  XX       //返回值

Author:  XX       //作者

Creation time:  xx  //创建时间

Alter by: XX       //修改者

Reason for Alter:  XX   //修改原因

Alter time:  XX       //修改原因

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


TAG:

 

评分:0

我来说两句

Open Toolbar