0. 我的C/C++文件头编写规范

自用的规范,参考自Google、华为与微软。

/*************************************
Module Name:  // 文件名
Project:              // 项目名称
Copyright © Ruojing Technologies Co., Ltd. 2017-2018. All rights reserved.                 
                           // 所有权声明
Author:              // 作者
ID:                      // 工号
Version:            // 版本
Date:                 // 完成日期
Description:     // 用于详细说明此程序文件完成的主要功能,与其他模块
                          // 或函数的接口,输出值、取值范围、含义及参数间的控
                          // 制、顺序、独立或依赖等关系
Others:             // 其它内容的说明。有的话就写,没有就略去
History:            // 修改历史记录列表,每条修改记录应包括修改日期、修改
                         // 者及修改内容简述
1. Date:
   Author:
   ID:
   Modification:
2. Date:
   Author:
   ID:
   Modification:
...
*************************************/
在整个C++代码中,只有文件头才使用/*...*/这样的注释方式,其余地方一律使用//注释。内容尽量使用英文。

猜你喜欢

转载自blog.51cto.com/13807182/2129398