1、源文件头部注释 列出：版权、作者、编写日期和描述。 示例： /************************************************* Copyright:radi Author: Date:2018-08-14 Description:描述主要实现 ...

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。鉴于Doxygen良好的注释风格，故基于Doxygen以形成自己的注释规范。 1.标注总述 //------------------------------------------------------------------- ...

@access 使用范围：class,function,var,define,module 该标记用于指明关键字的存取权限： private 、public 或 proteced @auth ...

2.1 注释的原则 注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。 示例：如下注释意义不大。 /* if receive_flag is TRUE */ if (receive_flag) 而如下的注释则给出了额外有用的信息 ...

C# 提供一种机制，使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中，具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成 XML。使用这类语法的注释称为文档注释(documentation comment)。这些注释后面必须紧跟用户定义 ...

（以下内容是综合网络整理得来，并不是标准，仅供参考，如哪位有标准写法，希望能分享一下，谢谢） 文件头部注释 在代码文件的头部进行注释，这样做的好处在于，我们能对代码文件做变更跟踪。在代码头部分标注出创始人、创始时间、修改人、修改时间、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改 ...

// 单行注释 是C++的注释方法，只能注释一行 /* */ 范围注释（注释对） 是C++从C语言继承过来的注释方法，“*”号之间是被注释掉的部分 注释对不能嵌套 e.g./*/* */*/编译会出错 Question：为什么要注释？ Answer：有时候我们需要 ...

规范的代码让程序具有美感，我更愿意去阅读她。 参考google编码规范 http://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/ 文件命名 总述 文件名要全部小写, 可以包含 ...