diff --git a/google-cpp-styleguide/comments.rst b/google-cpp-styleguide/comments.rst index 18afa98..af62996 100644 --- a/google-cpp-styleguide/comments.rst +++ b/google-cpp-styleguide/comments.rst @@ -37,7 +37,7 @@ 紧接着版权许可和作者信息之后, 每个文件都要用注释描述文件内容. - 通常, ``.h`` 文件要对所声明的类的功能和用法作简单说明. ``.cc`` 文件通常包含了更多的实现细节或算法技巧讨论, 如果你感觉这些实现细节或算法技巧讨论对于理解 ``.h`` 文件有帮助, 可以该注释挪到 ``.h``, 并在 ``.cc`` 中指出文档在 ``.h``. + 通常, ``.h`` 文件要对所声明的类的功能和用法作简单说明. ``.cc`` 文件通常包含了更多的实现细节或算法技巧讨论, 如果你感觉这些实现细节或算法技巧讨论对于理解 ``.h`` 文件有帮助, 可以将该注释挪到 ``.h``, 并在 ``.cc`` 中指出文档在 ``.h``. 不要简单的在 ``.h`` 和 ``.cc`` 间复制注释. 这种偏离了注释的实际意义.