c编程规范(编辑修改稿)

c编程规范(编辑修改稿)内容摘要：

注释与它注释的语句间不空行，但与其他的语句间空一行。 空格 在以下情况中要使用到空格 关键字和左括符 “ (” 应该用空格隔开。 如 while (true) C编程规范 注意 在方法名和 左括符 “ (” 之间不要使用空格，这样有助于辨认 代码 中的 方法调用 与 关键字。 多个参数用逗号隔开，每个逗号后都应加一个空格。 除了 . 之外，所有的二元操作符都应用空格与它们的操作数隔开。 一元操作符、 ++及 与操作数间不需要空格。 如 a += c + d。 a = (a + b) / (c * d)。 while (d++ = s++) { n++。 } PrintSize(“size is “ + size + “ \n”)。 语句中的表达式之间用空格隔开。 如 for (expr1。 expr2。 expr3) 括号 () 左括号 “ (” 不要紧靠关键字 ， 中间用一个空格隔开。 左括号“ (” 与方法名之间不要添加任何空格。 没有必要的话不要在返回语句中使用 ()。 如 if (condition) (1) return 1 花括号 {} 左花括号 “ {” 放于关键字或方法名的下一行并与之对齐。 如 if (condition) { } public int Add(int x, int y) { } 左花括号 “ {” 要与相应的右花括号 “ }”对齐。 通常情况下左花括号 “ {”单独成行，不与任何语句并列一行。 C编程规范 if、 while、 do 语句后一定要使用 {}，即使 {}号中为空或只有一条语句。 如 if (somevalue == 1) { somevalue = 2。 } 右花括号 “ }” 后建议加一个注释以便于方便的找到与之相应的 {。 如 while (1) { if (valid) { } // if valid else { } // not valid } // end forever C编程规范 第三章 程序注释 注释概述 修改代码时，总是使代码周围的注释保持最新。 在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。 注释样本应该是解释它为什么存在和可以做什么的简短介绍 . 避免在代码行的末尾添加注释；行尾注释使代码更难阅读。 不过在批注变量声 明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。 4 、 避免杂乱的注释，如一整行星号。 而是应该使用空白将注释同代码分开。 5 、 避免在块注 释的周围加上印刷框。 这样看起来可能很漂亮，但是难于维护。 6 、 在部署 发布 之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。 7 、 如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。 尽一切可能不注释难以理解的代码，而应该重写它。 尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。 8 、 在编写注释时使用完整的句子。 注释应该阐明代码，而不应该增加多义性。 9 、 在编写代码时就注释，因为以后很可能没有时间这样做。 另外，如果有机会复查已编 写的代码，在今天看来很明显的东西六周以后或许就不明显了。 10 、 避免多余的或不适当的注释，如幽默的不主要的备注。 1 使用注释来解释代码的意图。 它们不应作为代码的联机翻译。 1 注释代码中不十分明显的任何内容。 13 、 为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。 14 、 对由循环和逻辑分支组成的代码使用注释。 这些是帮助源代码读者的主要方面。 15 、 在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。 16 、 用空白将注释同注释分隔符分开。 在 没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。 17 、在所有的代码修改处加上 修改标识 的注释。 18 、为了是层次清晰，在闭合的右花括号后注释该闭合所对应的起点。 namespace { } // namespace 文档型注释 该类注释采用 .Net 已定义好的 Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释 ，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。 如 ///summaryMyMethod is a method in the MyClass class. ///paraHere39。 s how you could make a second paragraph in a description. ///see cref=/ ///for information about output statements. ////para ///seealso cref=/ ////summary public static void MyMethod(int Int1) C编程规范 { } 类 c 注释 该类注释用于 1 不再使用的代码。 2 临时测试屏蔽某些代码。 用法 /* [修改标识 ] [修改原因 ] . . . (the source code ) */ 单行注释 该类注释用于 1 方法内的代码注释。 如变量的声明、代码或代码段的解释。 注释示例： // // 注释语句 // private int number。 或 // 注释语句 private int number。 2 方法内变量的声明或花括号后的注释 , 注释示例 ： if ( 1 == 1) // always true { statement。 } // always true 注释标签 标签 用法 作用 c ctext/c 为您提供了一种将说明中的文本标记为代码的方法。 使用 code 将多行指示为代 C编程规范 text 希望将其指示为代码的文本。 码 para paracontent/para content段落文本。 用于诸如 remarks 或 returns 等标记内，使您得以将结构添加到文本中。 param param name=39。 name39。 description/param name 为 方法参数名。 将此名称用单引号括起来 (39。 39。 )。 应当用于方法声明的注释中，以描述方法的一个参数。 paramref paramref name=name/ name 要引用的参数名。 将此名称用双引号括起来 ( )。 paramref 标记为您提供了一种指示词为参数的方法。 可以处理 XML 文件，从而用某种独特的方法格式化该参数。 see see cref=member/ cref = member 对可以通过当前编译环境进行调用的成员或字段的引用。 编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。 必须将 member 括在双引号 ( ) 中。 使您得以从文本内指定链接。 使用 seealso 指示希望在 “ 请参阅 ” 一节中出现的文本。 seealso seealso cref=member/ cref = member 对可以通过当前编译环境进行调用的成员或字段的引用。 编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。 必须将 member 括在双引号 ( ) 中 使您得以指定希望在 “ 请参阅 ” 一节中出现的文本。 使用 see 从文本 example exampledescription/example description 代码示例的说明。 使 用 example 标记可以指定使用方法或其他库成员的示例。 一般情况下，这将涉及到 code 标记的使用。 code codecontent/code content 为希望将其标记为代码的文本。 记为您提供了一种将多行指示为代码的方法。 使用 c 指示应将说明中的文本标记为代 码 summary summarydescription/summary 此处 description 为 对象的摘要。 应当用于描述类型成员。 使用 remarks 以提供有关类型本身的信息。 exception exception cref=memberdescription/exception cref = member 对可从当前编译环境中获取的异常的引用。 编译器检查到给定异常存在后，将 member 转换为输出 XML 中的规范化元素名。 必须将 member 括在双引号 ( exception 标记使您可以指定类能够引发的异常。 C编程规范 ) 中。 description 说明。 include include file=39。 filename39。 path=39。 tagpath[@name=id]39。 / filename 包含文档的文件名。 该文件名可用路径加以限定。 将 filename 括在单引号中 (39。 39。 )。 Tagpath： filename 中指向标记名的标记路径。 将此路径括在单引号中 (39。 39。 )。 name 注释前边的标记中的名称说明符；名称具有一个 id。 id 位于注释之前的标记的 id。 将此 id 括在双引号中 ( )。 include 标记使您得以引用描述源代码中类型和成员的另一文件中的注释。 这是除了将文。