1 源文件头部注释
- 列出：版权、作者、编写日期和描述。
- /*************************************************
- Copyright:bupt
- Author:
- Date:2010-08-25
- Description:描述主要实现的功能
- **************************************************/
每行不要超过80个字符的宽度。
2 函数头部注释
/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
- /*************************************************
- Function: // 函数名称
- Description: // 函数功能、性能等的描述
- Calls: // 被本函数调用的函数清单
- Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）
- Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）
- Input: // 输入参数说明，包括每个参数的作
- // 用、取值说明及参数间关系。
- Output: // 对输出参数的说明。
- Return: // 函数返回值的说明
- Others: // 其它说明
- *************************************************/
3 数据结构声明的注释(包括数组、结构、类、枚举等)
如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。
- /* sccp interface with sccp user primitive message name */
- enum SCCP_USER_PRIMITIVE
- {
- N_UNITDATA_IND, /* sccp notify sccp user unit data come */
- N_NOTICE_IND, /* sccp notify user the No.7 network can not */
- /* transmission this message */
- N_UNITDATA_REQ, /* sccp user's unit data transmission request*/
- };
原文链接: https://www.cnblogs.com/liujiaknowledge/p/5367720.html
欢迎关注
微信关注下方公众号，第一时间获取干货硬货；公众号内回复【pdf】免费获取数百本计算机经典书籍
原创文章受到原创版权保护。转载请注明出处：https://www.ccppcoding.com/archives/231588
非原创文章文中已经注明原地址，如有侵权，联系删除
关注公众号【高性能架构探索】，第一时间获取最新文章
转载文章受原作者版权保护。转载请注明原作者出处！
