document/zh-google-styleguide
2
0
Fork 0
mirror of https://github.com/zh-google-styleguide/zh-google-styleguide.git synced 2026-08-13 22:13:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #17 from lzx1413/patch-2

Browse Source 
Fixes typo-
This commit is contained in:
Yang.Y
2015-10-30 08:53:05 +08:00
parent 50e4fd9281 1198d2bca7
commit 3dfeaf3223
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
google-cpp-styleguide/comments.rst
View File

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