C++代码注释

  1. 头文件
  2. 源文件
  3. 函数注释
  4. 类说明

头文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/*****************************************************************
* 模块名称:
* 建立时间:
* 模块作者:
* 描 述:
* 其 他:
* **************************************************************/

/*****************************************************************
* Module Name:
* Module Date:
* Module Auth:
* Description:
* Others:
* evision History:
* DateRel VerNotes
* XX/XX/XXXXX.X
* **************************************************************/

源文件

函数注释

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/*****************************************************************
* 函数名字:
* 函数功能:
* 函数输入:
* 函数输出:
* **************************************************************/


/*****************************************************************
* Function://函数名称
* Description://函数功能,性能等的描述
* Calls://备货单本函数调用的函数清单
* Called By://调用的本函数的清单
* Input://输入参数说明,包括每个参数的作用、取值说明及参数间关系
* Output://输出参数的说明
* Return://函数返回值的说明
* Others://其他说明
* **************************************************************/

类说明

1
2
3
4
5
6
7
8
/*****************************************************************
* 类名字:
* 类功能:
* 基类:
* 公有成员:
* 保护成员:
* 私有成员:
* **************************************************************/

微信:宏沉一笑
公众号:漫步之行

签名:Smile every day
名字:宏沉一笑
邮箱:whghcyx@outlook.com
个人网站:https://whg555.github.io



转载请注明来源,欢迎对文章中的引用来源进行考证,欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论,也可以邮件至 whghcyx@outlook.com

文章标题:C++代码注释

文章字数:238

本文作者:宏沉一笑

发布时间:2020-04-20, 00:00:00

最后更新:2023-06-20, 12:47:02

原始链接:https://whghcyx.gitee.io/2020/04/20/IT-2020-4-20-C-%E4%BB%A3%E7%A0%81%E6%B3%A8%E9%87%8A/

版权声明: "署名-非商用-相同方式共享 4.0" 转载请保留原文链接及作者。

目录
×

喜欢就点赞,疼爱就打赏