金山软件C/C++编码规范

"金山编码规范(PDF)" 是金山软件股份有限公司在2004年4月发布的一份针对C/C++编程的源代码书写规范，旨在统一研发部门的编码风格，便于代码阅读、维护和管理。该规范由研发部多位代表共同讨论制定，并要求所有新增和修订的代码需遵循此规范。 规范内容包括多个方面： 1. **文件起始处的说明**：每个.h或.cpp文件开头应包含文件名、创建人、创建日期以及简短的功能描述。这有助于追踪代码来源和理解代码功能。 2. **关于注释**：规范可能详细规定了注释的格式和内容，如单行注释、多行注释的使用，以及如何清晰地描述函数或变量的作用。 3. **每行代码长度**：为了保持代码的可读性，规范可能限制了每行代码的最大字符数，避免过长的代码行。 4. **合并行的问题**：可能规定何时应该将长表达式拆分为多行，以及如何正确地进行行连接。 5. **指针中*号的位置**：指针声明时，*号通常与变量名放在一起，以提高可读性。 6. **全局函数的调用**：可能要求使用特定的调用约定或命名规则，以减少全局作用域的污染。 7. **关于if-else**：规范可能建议使用花括号包围if-else语句的块，即使只有一行代码，以防止潜在的错误。 8. **与“{”、“}”有关的规定**：可能包括如何正确地对代码块进行缩进和配对，以及在何处放置花括号。 9. **与空格有关的规定**：比如在运算符周围添加空格以提高可读性，或者在括号内避免不必要的空格。 10. **与缩进有关的各项规定**：规定缩进的单位（通常是空格或制表符），以及如何保持嵌套结构的清晰。 11. **关于出错处理**：可能涉及到错误处理机制，如异常处理或返回错误码。 12. **与类相关的.h文件与.cpp文件**：可能涉及头文件和实现文件的分离，以及如何在它们之间声明和定义成员。 13. **注释书写与自动生成帮助文档规范**：规定如何编写docstrings或其他形式的文档注释，以便自动生成API文档。 此外，规范还包括两个附录： - **命名规范**：详细规定了变量、函数、类等的命名规则，可能包括驼峰式命名、下划线分隔等。 - **通用缩写表**：列出常用的编程缩写及其全称，以确保一致性。 这份规范的修订和更新需要通过研发部经理组织的集体讨论，并且由指定人员执笔修改。其最初的起草人和执笔人也列在文档中。