C语言编写规范之注释
c语言初学者编程规范注释
C语言初学者编程规范—注释1 注释的原则和目的注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。
通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的——清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释——过量的注释则是有害的。
注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。
示例：如下注释意义不大。
/* if receive_flag is TRUE */if (receive_flag)而如下的注释则给出了额外有用的信息。
/* if mtp receive a message from links */if (receive_flag)2 函数头部应进行注释函数头部应进行注释，列出：函数的目的/ 功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
示例1：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/*************************************************Function: // 函数名称Description: // 函数功能、性能等的描述Calls: // 被本函数调用的函数清单Called By: // 调用本函数的函数清单Input: // 输入参数说明，包括每个参数的作// 用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明Others: // 其它说明*************************************************/对于某些函数，其部分参数为传入值，而部分参数为传出值，所以对参数要详细说明该参数是入口参数，还是出口参数，对于某些意义不明确的参数还要做详细说明(例如：以角度作为参数时，要说明该角度参数是以弧度(PI),还是以度为单位),对既是入口又是出口的变量应该在入口和出口处同时标明。
C语言程序解释—注释
C语言程序解释——注释
注释是为了使别人能看懂你写的程序，也为了使你在若干年后还能看得懂你曾经写的程序而设定的。
注释是写给程序员看的，不是写给电脑看的。
所以注释的内容，C语言编译器在编译时会被自动忽略。
C语言注释方法有两种：
多行注释： /* 注释内容 */
单行注释： //注释一行
以下是使用多行注释与单行注释的例子：
运行结果：
我们可以看出在该例子的运行结果中并没有看到注释的内容，正说明了注释在编译的时候会自动忽略掉。
任务
右侧是小编写的代码，但是他忘记加上注释了，你能帮小编加一下吗？
在右边编辑器中
第4行输入单行注释；
9-12行输入多行注释。
运行结果如下：
不会了怎么办
1、多行注释是使用/* */。
2、单行注释是使用//。
c语言编程的书写规则
c语言编程的书写规则C语言编程的书写规则主要遵循以下规范：1. 缩进和空格：缩进和空格的使用可以使代码更易读。
通常，运算符两侧、逗号之后、控制语句（如if、for、while等）前后应添加空格。
在函数和括号的开头和结尾，通常应有空行。
2. 命名规则：变量和函数名应简洁且有意义。
通常，变量名和函数名以小写字母开头，后续单词的首字母大写，如 `myVariable`。
3. 注释：注释应简洁明了，解释代码的作用或目的，而不是解释代码是如何工作的。
注释应放在代码的上方或旁边，与代码保持一定距离。
4. 函数：函数应该尽可能短小，只做一件事情。
函数应具有描述性的名称，参数列表应清晰，并应包含返回类型。
5. 大括号：在C语言中，大括号 `{}` 用于定义代码块。
每一个独立的语句块都应该使用大括号。
6. 控制结构：控制结构（如if-else、for、while等）应该清晰明了，控制语句应只包含必要的逻辑。
7. 类型定义：类型定义应清晰明了，如果有必要，可以使用typedef来定义新的类型名称。
8. 预处理器指令：预处理器指令（如include、define等）应放在源文件的顶部。
9. 避免魔法数字和字符串：魔法数字和字符串（硬编码的值）会使代码难以理解和维护。
如果需要在代码中使用特定的值，应将其定义为常量或宏。
10. 避免全局变量：全局变量会使代码难以理解和维护，并可能导致意外的副作用。
尽可能使用局部变量。
11. 错误处理：在可能失败的操作后，应检查错误并相应地处理它们。
以上只是一些基本的C语言编程规则，实际编写代码时可能还需要考虑更多因素，如代码的可读性、可维护性、性能等。
c 编程规范
c 编程规范C 编程规范是用来规范 C 语言程序代码风格和编写规范的一系列准则。
遵循 C 编程规范可以提高代码的可读性、可维护性，减少错误和 bug 的发生。
以下是一些常见的 C 编程规范建议：1. 代码缩进：缩进应该使用相同数量的空格符或制表符，一般为 4 个空格或一个制表符。
缩进可以使代码结构更清晰，便于阅读。
2. 命名规范：变量、函数和常量的命名应该具有描述性，能够准确反映其用途和含义。
使用驼峰命名法或下划线命名法是常见的命名风格。
注意避免使用与 C 语言关键字相同的名称。
3. 注释规范：代码中应该包含必要的注释，用于解释代码的逻辑、实现细节和算法。
注释应该清晰明了，不要出现拼写错误或过多的冗余信息。
4. 函数长度：函数的长度应该适中，不要过长。
一般来说，一个函数应该只负责一个具体的功能，如果函数过长应该考虑分割成多个子函数。
5. 模块化设计：程序应该使用模块化的设计原则，将功能相似或相关的代码块组织成不同的模块或文件。
这样可以提高代码的可维护性和可重用性。
6. 错误处理：程序应该正确处理各种可能发生的错误和异常情况。
避免简单地使用错误代码或忽略错误，而是采取适当的错误处理措施，例如返回错误码或抛出异常。
7. 变量声明：变量应该在使用前先声明，并且尽量在被使用的代码块的起始处进行声明。
声明时应给予适当的初始值，以避免使用未初始化的变量。
8. 代码复用：避免重复的代码和冗余的逻辑。
可以通过编写可重用的函数、使用循环和条件语句等方式来提高代码的复用性和可读性。
9. 括号的使用：括号的使用是保证代码逻辑准确性的重要方式之一。
建议在 if、for、while、switch 等语句块的使用中，使用括号来明确代码块的范围，以避免出现逻辑错误。
10. 代码格式：代码应该有一致的格式，用以增加可读性。
应避免使用过长的代码行，一般建议每行代码长度不超过 80 个字符。
综上所述，C 编程规范是编写高质量、可维护代码的基本准则。
c语言 函数注释
c语言函数注释函数注释是编程中非常重要的一部分，它能够帮助其他开发者理解函数的作用、参数要求以及返回值等信息。
在C语言中，函数注释通常使用特定的格式进行书写，以确保注释的清晰易读。
本文将介绍C语言函数注释的格式要求以及如何编写规范的函数注释。
一、函数注释的格式要求在C语言中，函数注释通常位于函数声明之前，使用特定的注释格式进行书写。
以下是常用的函数注释格式要求：1. 函数注释以"/**"开始，以"*/"结束，中间的内容为注释的具体描述。
2. 注释的第一行为函数的摘要描述，简明扼要地说明函数的功能。
3. 注释的后续行为详细描述，可以包括函数的参数说明、返回值说明、异常情况说明等。
4. 参数说明应包括参数的名称、类型、作用、是否可以为空等信息。
5. 返回值说明应说明函数的返回值类型、返回值的作用、取值范围等信息。
6. 异常情况说明应说明函数可能出现的异常情况以及如何处理。
7. 注释中可以使用合适的标点符号、缩进、换行等方式使注释更易读。
二、编写规范的函数注释1. 函数摘要描述：函数的摘要描述应简明扼要地说明函数的功能。
例如，对于一个计算两个数之和的函数，可以使用以下方式进行摘要描述：/*** 计算两个数的和*/2. 参数说明：参数说明应包括参数的名称、类型、作用、是否可以为空等信息。
例如，对于一个计算两个数之和的函数，可以使用以下方式进行参数说明：/*** 计算两个数的和** @param num1 第一个操作数* @param num2 第二个操作数** @return 两个数的和*/3. 返回值说明：返回值说明应说明函数的返回值类型、返回值的作用、取值范围等信息。
例如，对于一个计算两个数之和的函数，可以使用以下方式进行返回值说明：/*** 计算两个数的和** @param num1 第一个操作数* @param num2 第二个操作数** @return 两个数的和* 如果计算结果超出了整型的表示范围，则返回0*/4. 异常情况说明：异常情况说明应说明函数可能出现的异常情况以及如何处理。
c语言程序的注释
c语言程序的注释注释是程序中用来解释代码功能的一种方式。
通过注释，我们可以清晰地了解代码的目的、实现方式以及可能存在的问题。
在C语言中，注释有两种形式：单行注释和多行注释。
单行注释以"//"开头，用于注释单行代码。
多行注释以"/*"开始，以"*/"结束，可以注释多行代码。
在编写C语言程序时，注释是非常重要的。
它可以帮助其他人理解你的代码，也可以帮助自己在以后的开发中快速回忆代码的功能。
因此，良好的注释习惯是每个程序员都应该养成的。
注释应该清晰明了，使用简洁明了的语言描述代码的功能。
注释的内容应该能够准确地传达代码的意图，避免歧义或错误信息的出现。
如果代码存在特定的算法或逻辑，可以简要描述其实现方式，但不要输出公式。
注释应该避免重复。
在编写注释时，应该注意不要重复代码本身已经表达的信息。
如果代码的含义已经很明确，就不需要再做重复的解释。
注释应该关注代码的关键点，对于一些常见的操作，可以省略注释。
注释应该符合整体的格式规范。
可以使用适当的段落和标题，使文章结构清晰，易于阅读。
可以使用恰当的标点符号和格式来分隔不同的注释内容，使其更加有序。
在编写注释时，也应该注意避免输出不必要的信息。
不要输出HTTP 地址或任何可能会导致安全问题的信息。
保护用户的隐私是每个程序员的责任，不能因为疏忽而导致信息泄露。
在注释中也不应该重复提及问题。
如果在代码中存在某个问题，应该在代码本身中解决，并在注释中说明解决方案。
不要通过重复问题来强调问题的存在，而是应该注重解决问题的方法。
注释应该使用丰富的词汇和通顺的语句。
避免使用重复的词汇或语句，使注释更加生动有趣。
可以使用不同的词汇和句式来表达相同的意思，增加注释的可读性。
注释是程序中不可或缺的一部分。
通过良好的注释习惯，我们可以提高代码的可读性和可维护性，帮助其他人更好地理解我们的代码。
同时，注释也是我们自己回顾代码的重要工具。
C#注释规范
C#注释规范第一篇：C# 注释规范C# 注释（Comment）规范注释规范包括：模块（类）注释规范、类的属性、方法注释规范、代码间注释1.模块（类）注释规范模块开始必须以以下形式书写模块注释：//////模块编号： ///作用： ///作者：作者中文名///编写日期：/// 如果模块有修改，则每次修改必须添加以下注释：/// ///Log编号：///修改描述： ///作者：修改者中文名///修改日期： ///2.类属性注释规范在类的属性必须以以下格式编写属性注释：/// ///属性说明 ///3.方法注释规范在类的方法声明前必须以以下格式编写注释/// /// 说明：/// ///"> /// /// ///4.代码间注释规范代码间注释分为单行注释和多行注释：单行注释： //多行注释： /*多行注释1 多行注释2 多行注释3*/代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。
详细介绍见：第二篇：C#编码规范及命名规范山东锋士自动化系统有限公司C# 编码规范指导规则和最佳实践 Version 1.0董毅 2010/4/26第一条编码的风格和细节要求编码风格至少在单一文件中缩进和风格要保持一致，同一行中内容不要太长，最好不要大于10个单词。
不要随意地或者以容易混淆作用域嵌套关系的方式放置括号，要尽量遵循每个文件中已经使用的体例。
命名约定和规范1.不要使用晦涩的名称，起名要简单易懂a.避免使用单字母做变量名，比如：i 或者t。
应使用index或者temp进行替代b.不要缩写单词，比如用num代替number 2.使用全大写字母表示宏，常量，如：LIKE_THIS 3.类，函数和枚举的名称的单词首字母大写，如：LikeThis public class SomeClass {const int DefaultSize = 100;public void SomeMethod(){ } } 4.变量的首字母小写，其他单词首字母大写，如：likeThis void MyMethod(int someNumber){ int number;} 5.接口的第一个字母用I开头interface IMyInterface {...} 6.私有成员变量以m_开头，剩余内容遵从首字母大写的规范public class SomeClass { private int m_Number;} 7.属性类以Attribute做后缀，异常类以Exception做后缀8.命名方法以【动词】-【目标】组成，比如：ShowDialog（）9.拥有返回值的方法应该以返回值描述其方法名，比如：GetObjectState（）10.总是使用C#的预定义类型，而不是System命名空间中的别名，比如：object 而不是Object string 而不是String int而不是Int32 11.对于基类，类型描述采用大写字母。
c语言函数注释写法
在 C 语言中，函数注释通常使用特定的格式和标记，以便在代码中提供清晰的文档和说明。
以下是一种常见的 C 语言函数注释写法：
/**
* @brief 简要描述函数的作用
*
* @param parameter1 参数1的描述
* @param parameter2 参数2的描述
*
* @return 返回值的描述
*/
让我们来解释一下这个注释的各个部分：
- `@brief`：用于简要描述函数的作用。
这里应该提供一个简洁的概述，说明函数的作用和功能。
- `@param`：用于描述函数的参数。
在每个`@param` 标记后面，应该提供参数的名称以及对参数的描述。
这有助于其他开发者理解函数的输入参数。
- `@return`：用于描述函数的返回值。
在`@return` 标记后面，应该提供对返回值的描述，包括返回值的含义和可能的取值范围。
这种注释写法可以帮助其他开发者更容易地理解函数的作用和用法，尤其是在阅读他人的代码或者协作开发时。
同时，一些文档生成工具（如Doxygen）也可以识别这种格式的注释，并生成函数文档。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
1、头文件包含Includes
2、私有类型定义 Private typedef
3、私有定义Private define
4、私有宏定义 Private macro
5、私有变量 Private variables
6、私有函数原型Private function prototypes
7、私有函数Private functions
8、私有函数前注释
/****************************************************************************** *
* Function Name : FSMC_NOR_Init
* Description : Configures the FSMC and GPIOs to interface with the NOR memory. * This function must be called before any write/read operation * on the NOR.
* Input : None
* Output : None
* Return : None
******************************************************************************* /
9、程序块采用缩进风格编写，缩进空格为4。
10、相对独立的程序块之间、变量说明之后必须加空行；
11、较长的字符（>80字符）要分成多行书写，长表达式要在低优先级操作符划分新行，操作符放在新行之首，新行要恰当缩进，保持排版整齐；
12、循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首;
13、若函数或过程中的参数较长，则要进行适当的划分。
14、不允许把多个短语句写在一行中，即一行只写一条语句。
15、if、for、do、while、case、switch、default等语句自占一行，且if、for、
do、while等语句的执行语句部分无论多少都要加括号{}。
16、对齐只使用空格键，不使用TAB键；
17、
函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case
语句下的情况处理语句也要遵从语句缩进要求
18、
程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一
列，同时与引用它们的语句左对齐。
在函数体的开始、类的定义、结构的定义、枚举的定义以
及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
19、
在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或
者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格；
20、一行程序以小于80字符为宜，不要写得过长。
21、一般情况下，源程序有效注释量必须在20％以上。
注释不宜太多、不宜太少，准确易懂简洁；
22、
说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应
进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的
关系、修改日志等，头文件的注释中还应有函数功能简要说明。
23、
源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
如：
24、
函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用
关系（函数、表）等。
边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。
不再有
用的注释要删除
26、
注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：错误的注释不但无益反而有害；
27、
避免在注释中使用缩写，特别是非常用缩写；
28、
注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）
相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
29、
数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须
加以注释。
对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注
释放在此域的右方；
30、
全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及
存取时注意事项等的说明。
31、
注释与所描述内容进行同样的缩排
32、将注释与其上面的代码用空行隔开；
33、对变量的定义和分支语句（条件分支、循环语句等）必须编写注释；
34、
对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一
个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释；
35、
通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构；
在代码的功能、意图层次上进行注释，提供有用、额外的信息。
在程序块的结束行右方加注释标记，以表明某程序块的结束。
说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。
37、
注释格式尽量统一，建议使用“/* …… */”
38、
注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达；
.。