注释可以出现在c语言任何位置,在c程序中,注释语句只能位于一条语句的后面吗...
错误,在C语言中注释部分对程序的运行结果不产生任何影响,它可以出现在程序的任何位置。在C语言中有两种注释方式:一种是以“/*”开始、以“*/”结束的块注释;一种是以“//”开始、以换行符结束的单行注释。
相关推荐:C语言视频教程
C语言中的注释
在编写C语言源代码时,应该多使用注释,这样有助于对代码的理解。在C语言中有两种注释方式:一种是以/*开始、以*/结束的块注释(block comment);
另一种是以//开始、以换行符结束的单行注释(line comment)。
可以使用/*和*/分隔符来标注一行内的注释,也可以标注多行的注释。例如,在下列的函数原型中,省略号的意思是 open() 函数有第三个参数,它是可选参数。注释解释了这个可选参数的用法:int open( const char *name, int mode, … /* int permissions */ );
可以使用//插入整行的注释,或者将源代码写成两列分栏的格式,程序在左列,注释在右列:const double pi = 3.1415926536; // pi是—个常量
在 C99 标准中,单行注释正式加入C语言,但是大部分编译器在 C99 之前就已经开始支持这种用法。有时候,其被称作“C++风格”的注释,但实际上,其源自于C的前身 BCPL。
注释的位置
在C语言中注释部分对程序的运行结果不产生任何影响,它可以出现在程序的任何位置。
示例:int/*....*/i; //正确
char* s="abcdefgh //hijklmn"; //正确
in/*...*/ti; //错误注释会被空格替换
//注意: /*...*/不能嵌套 ,/*总是与离他最近的*/匹配
y=x/*p // 该语句由于没有找到*/ 会报错
//要实现以上功能 可以用y=x/(*p)或y=x/ *p代替
注释规范
2-1:一般情况下,源程序有效注释量必须在20%以上。
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。
2-2:文件头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、修改日志等。
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*****************************************************************************
Copyright: 1988-1999, Huawei Tech. Co., Ltd.
File name: 文件名
Description: 用于详细说明此程序文件完成的主要功能,与其他模块或函数的接口,输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系
Author: 作者
Version: 版本
Date: 完成日期
History: 修改历史记录列表, 每条修改记录应包括修改日期、修改者及修改内容简述。
*****************************************************************************/
2-3:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*************************************************
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序)
Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)
Input: // 输入参数说明,包括每个参数的作// 用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明
Others: // 其它说明
********************************************/
2-4:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
2-5:注释的内容要清楚、明了,含义准确,防止注释二义性。说明:错误的注释不但无益反而有害。
2-6:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
示例:如下例子不符合规范。
例1:/* get replicate sub system index and net indicator */
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
例2:repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
/* get replicate sub system index and net indicator */
应如下书写/* get replicate sub system index and net indicator */
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
2-7:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
示例:/* active statistic task number */
#define MAX_ACT_TASK_NUMBER 1000
#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */
2-8:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。
示例:可按如下形式说明枚举/数据/联合结构。/* sccp interface with sccp user primitive message name */
enum SCCP_USER_PRIMITIVE
{
N_UNITDATA_IND, /* sccp notify sccp user unit data come */
N_NOTICE_IND, /* sccp notify user the No.7 network can not */
/* transmission this message */
N_UNITDATA_REQ, /* sccp user’s unit data transmission request */
};
2-9:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
示例:/* The ErrorCode when SCCP translate */
/* Global Title failure, as follows */ // 变量作用、含义
/* 0 - SUCCESS 1 - GT Table error */
/* 2 - GT error Others - no use */ // 变量取值范围
/* only function SCCPTranslate() in */
/* this modual can modify it, and other */
/* module can visit it through call */
/* the function GetGTTransErrorCode() */ // 使用方法
BYTE g_GTTranErrorCode;
2-10:注释与所描述内容进行同样的缩排。
说明:可使程序排版整齐,并方便注释的阅读与理解。示例:如下例子,排版不整齐,阅读稍感不方便。void example_fun( void )
{
/* code one comments */
CodeBlock One
/* code two comments */
CodeBlock Two
}
应改为如下布局。void example_fun( void )
{
/* code one comments */
CodeBlock One
/* code two comments */
CodeBlock Two
}
2-11:避免在一行代码或表达式的中间插入注释。
说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。
2-12:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。
说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。
2-13:在代码的功能、意图层次上进行注释,提供有用、额外的信息。
说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。
示例:如下注释意义不大。/* if receive_flag is TRUE */
if (receive_flag)
而如下的注释则给出了额外有用的信息。/* if mtp receive a message from links */
if (receive_flag)
2-14:在程序块的结束行右方加注释标记,以表明某程序块的结束。
说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。示例:参见如下例子。if (…)
{
// program code
while (index < MAX_INDEX)
{
// program code
} /* end of while (index < MAX_INDEX) */ // 指明该条while 语句结束
} /* end of if (…)*/ // 指明是哪条if 语句结束
2-15:注释格式尽量统一,建议使用“/*…… */”。
2-16:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。
说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。
更多编程相关知识,请访问:编程教学!!
注释可以出现在c语言任何位置,在c程序中,注释语句只能位于一条语句的后面吗...相关推荐
- c语言注释语句的作用,在C程序中,注释说明只能位于一条语句的后面。
中注释下列属于"如何克服紧张"的叙述是( ). 对犯罪分子判处罚金,程序确定罚金的数额应当根据( ) 说明下列说法中正确的是: . 下列各情况中,位于甲乙构成共同犯罪的是( ) 条 ...
- c语言源程序要求每行只能书写一条语句,C语言章节习题集(全)
可编辑 C语言程序设计 第一.二章 单项选择题 1. 将汇编语言编写的程序翻译成目标程序的程序是() A)解释 B)编译 C)汇编 D)目标 2. 不属于面向机器语言的是() A)符号语言 B)二进制 ...
- c语言程序中注释的格式化,格式化C语言命令indent
indent是linux下一个能力极强的代码整理软件,使用他,可以轻松的写出代码风格十分精良的代码. 但是indent的参数太多,使用起来不是很容易,怎么办呢? 查看 /usr/src/linux-h ...
- 用python语言实现游戏关卡之间的转化_用python tkinter 129条语句实现2048游戏
2048游戏规则如下,游戏由16个正方体组成4行4列矩阵,每个正方体显示可以为空,也可以显示2.4.8.16.32-2048.4096任一数字.初始矩阵只有2个正方体有数字,其余全为空,这两个数字可为 ...
- C语言运行超过运行限制,程序中的一些限制(基于Linux系统C语言)
今天突然想起来几个问题,在程序运行起来时,存在一些限制: 1,数组的长度(成员的个数)存在限制!(数组定义的空间大小) 2,一个进程里打开的文件数. 3,一个文件的名字的长度. 4,一个进程里创建线程 ...
- c语言程序中注释定义,C语言语法基础:函数注释等等
任何语言的入门大部分都是从Hello World开始的,我们学习到C语言也不例外.现在很多人说C语言很难,建议Java或者是Python入门.四喜想说的是,万事开头难,如果以C语言入门,之后的其他语言 ...
- 在c51语言的程序中 注释一般采用,【判断题】在 C51 语言的程序中,注释一般采用 /* */ 和 // 来实现。 (3.0分)...
当ab<0时,化简a2b的结果是()A.-abB.a-bC.-a-bD.ab (-5)2的化简结果为()A.25B.5C.-5D.-25 计算:-12764=______. 已知两圆的半径分别3 ...
- python用api调用c语言_在C/C++程序中调用High Level的Python API
Python API的类型 分为High Level API和Low Level API. Low Level API是API的基础,调用High Level API时,Python基础库会为C/C+ ...
- C语言入门学习——如何在程序中使用空格
首先我们来看一下下面这段代码 #include<stdio.h> int main() {int divisor;int n;scanf("%d",&n);if ...
最新文章
- Open3d学习计划—高级篇 5(RGBD融合)
- 《Java编码指南:编写安全可靠程序的75条建议(英文版)》—— 2.7 修复错误...
- libsvm Minist Hog 手写体识别
- 《为自己工作——世界顶级设计师成功法则》—第1章1.7节平衡
- python httpstr find_Python爬虫 | BeautifulSoup使用
- HEU 2036 Paths on a Grid
- 递归函数就兔子数C语言,【C语言】求斐波那契(Fibonacci)数列通项(递归法、非递归法)...
- spark多个kafka source采用同一个group id导致的消费堆积延迟
- manjaro 搜狗输入法_Manjaro日常使用 之一:日常办公
- php中throw try,PHP的Try, throw 和 catch简单用法_PHP教程
- ACM PKU 1019 Number Sequence http://acm.pku.edu.cn/JudgeOnline/problem?id=1019
- 五颜六色 CSS颜色代码表
- 2.3、IPMP,PMP,PRINCE2
- python创建xlsx文件_教程1:创建一个简单的XLSX文件
- 【《Unity Shader入门精要》 提炼总结】(十三)第十三章·透明度测试的Shader实现透明度混合的Shader实现
- Bigemap APP(Android)手机离线地图使用说明
- linux scp 排除文件夹,scp复制文件时排除指定文件
- 谷歌浏览器chrome扩展插件-农名的世界脚本
- Web负载均衡的几种实现方式
- 你的计算机由组织管理,某些设置由你的组织来管理