跳转到内容

软件工程师手册/支持流程/编码标准

来自维基教科书,开放书籍,开放世界

以下是维基百科条目关于 编码标准

编码标准通常包含针对特定语言的一组约定。通常涵盖的项目包括

  • 命名约定,包括
    • 名称应该多描述性,多长,
    • 应该使用什么大写方案,以及
    • 后缀和前缀约定是什么。
  • 物理组织,例如定义应位于头文件中。不要在一个文件中包含多个类。
  • 结构约定,例如打开和关闭大括号应位于同一列,如下所示:
{
    {
        // code in here
    }
}
  • 样式指南,例如包含指针的类应具有虚拟析构函数。 包含此类标准的推理和参考非常有用。
  • 遗留代码指南,例如在编辑现有代码时,请遵循现有代码的编码命名和结构约定。

命名约定

[编辑 | 编辑源代码]

"始终、始终、始终使用好的、未缩写的、拼写正确的有意义的名称。" -- c2: 有意义的名称

流行的命名约定(命名格式)包括

  • ALL_UPPERCASE_WITH_UNDERSCORES
  • all_lowercase_with_underscores
  • CamelCase
  • uppercaseOnlyInTheMiddle
  • _UnderscorePrefixedCamelCase
  • Camel_Case_With_Underscores

关于命名约定的意外冗长对话,请参阅 c2: 下划线与大写和小写变量命名; 维基百科:驼峰式大小写; c2: 驼峰式大小写; 以及 "下划线与驼峰式大小写".

进一步阅读

[编辑 | 编辑源代码]
华夏公益教科书