c语言中注释的位置 87、在C语言程序中,注释部分从哪开始,到哪结束?

c\u8bed\u8a00\u6e90\u7a0b\u5e8f\u7684\u6ce8\u91ca\u8bf4\u660e\u4f4d\u4e8e\u4ec0\u4e48\u4f4d\u7f6e\uff1f\u662f\u4e0d\u662f\u975e\u5f97\u5728\u6ce8\u91ca\u4e4b\u540e

\u53ea\u8981\u4e0d\u7834\u574f \u58f0\u660e\u548c\u8bed\u53e5 \u7684\u610f\u601d\u548c\u7ed3\u6784\uff0c\u653e\u5728\u54ea\u91cc\u90fd\u53ef\u4ee5\u3002
\u4f8b\u5982\uff0c\u4e0d\u8981\u653e\u5728\u5b8f\u7684\u540c\u884c\uff0c\u4e0d\u8981\u653e\u5230 \u6253\u5370\u683c\u5f0f \u5b57\u7b26\u4e32\u91cc\u3002
\u4e24\u79cd\u6ce8\u91ca\u5199\u6cd5
/* \u6ce8\u91ca */
// \u6ce8\u91ca

\u6709\u4e8c\u79cd\u5f62\u5f0f\uff0c\u4ece//\u5f00\u59cb\u5230\u884c\u672b\u7ed3\u675f\uff0c
\u6216\u4ece/*\u5f00\u59cb\uff0c\u5230*/\u7ed3\u675f\u3002

1、可以使用/*和*/分隔符来标注一行内的注释,也可以标注多行的注释。例如,在下列的函数原型中,省略号的意思是 open() 函数有第三个参数,它是可选参数。注释解释了这个可选参数的用法:

int open( const char *name, int mode, … /* int permissions */ );

2、可以使用//插入整行的注释,或者将源代码写成两列分栏的格式,程序在左列,注释在右列:

const double pi = 3.1415926536;       // pi是—个常量

扩展资料

在 C99 标准中,单行注释正式加入C语言,但是大部分编译器在 C99 之前就已经开始支持这种用法。有时候,其被称作“C++风格”的注释,但实际上,其源自于C的前身 BCPL。

1、在引号中,如果采用/*或//分隔一个字符常量或字符串字面量(string literal),它们都不会被视为注释的开始。例如,下面语句就没有注释:

printf("Comments in C begin with /* or //.
" );

2、预处理器仅通过检查注释的结束符来检测注释中的字符,因此,不能嵌套块注释。然而,可以使用/*和*/注释包含单行注释的源代码:

/* 暂时注释掉这两行:

    const double pi = 3.1415926536;  // pi是一个常量

    area = pi * r * r;   // 计算面积

暂时注释到此 */



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),还是以度为单位),对既是入口又是出口的变量应该在入口和出口处同时标明。等等。

在注释中详细注明函数的适当调用方法,对于返回值的处理方法等。在注释中要强调调用时的危险方面,可能出错的地方。
3 进行注释时的注意事项(1)建议边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

(2)注释的内容要清楚、明了,含义准确,防止注释二义性。说明:错误的注释不但无益反而有害。

(3)避免在注释中使用缩写,特别是非常用缩写。在使用缩写时或之前,应对缩写进行必要的说明。

(4)注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面。除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。

示例:如下例子不符合规范。

例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;

(5)对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

示例:
/* active statistic task number */
#define MAX_ACT_TASK_NUMBER 1000
#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */

(6)数据结构声明( 包括数组、结构、类、枚举等) ,如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。

示例:可按如下形式说明枚举/数据/联合结构。
/* 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*/
};

(7)全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

示例:
/* 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;

(8)注释与所描述内容进行同样的缩排,让程序排版整齐,并方便注释的阅读与理解。

示例:如下例子,排版不整齐,阅读稍感不方便。
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
}

(9)将注释与其上面的代码用空行隔开。

示例:如下例子,显得代码过于紧凑。
/* code one comments */
program code one
/* code two comments */
program code two
应如下书写
/* code one comments */
program code one

/* code two comments */
program code two

(10)对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。

(11)对于switch 语句下的case 语句,如果因为特殊情况需要处理完一个case 后进入下一个case 处理(即上一个case后无break),必须在该case 语句处理完、下一个case 语句前加上明确的注释,以清楚表达程序编写者的意图,有效防止无故遗漏break语句(可避免后期维护人员对此感到迷惑:原程序员是遗漏了break语句还是本来就不应该有)。示例:
case CMD_DOWN:
ProcessDown();
break;
case CMD_FWD:
ProcessFwd();
if (...)
{
...
break;
} else
{
ProcessCFW_B(); // now jump into case CMD_A
}
case CMD_A:
ProcessA();
break;
...

(12)在程序块的结束行右方加注释标记,以表明某程序块的结束。当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。示例:参见如下例子。
if (...)
{
program code
while (index < MAX_INDEX)
{
program code
} /* end of while (index < MAX_INDEX) */ // 指明该条while语句结束
} /* end of if (...)*/ // 指明是哪条if语句结束

(13)在顺序执行的程序中,每隔3—5行语句,应当加一个注释,注明这一段语句所组成的小模块的作用。对于自己的一些比较独特的思想要求在注释中标明。

(14)注释格式尽量统一,建议使用“/* …… */”。

(15)注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达——注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。

变量、保留字的字符之间不能有注释其他任何位置都可以加注释
包括:
一、单独一行可以在任何位置
二、与其他语句在一行,可以在末尾
三、在一行的首位置
四、在中间的任意位置
当然这里的注释是指/* */这样的有界限的不是//这样的注释,//只使用与第一二两种情况。

一般来讲有两种:
一是单行注释:直接在该行需要注释的地方加上"//"就行了。例如:
"int a,b;//这是一个注释行"。那么,"//"后面的部分"这是一个注释行"就被注释掉了,不起作用,但是"//"前面的“int a,b;"不受影响。
另外还有一种是多行同时注释:
/*
int a,b;
int c,d;
*/
其中"/*"和"*/"起限定范围的作用,该范围内的语句都会被注释掉,将不再起作用。当然,多行注释也是可以用来单行注释的

       首先通过精心设计的数据结构、恰当的函数和变量命名以及良好的代码缩进,使得别人可以读代码就能理解程序的用意,把注释降低到最低。因为满篇的注释可能恰恰暴露了你的程序设计的不合理。但有一些注释是必须要的:

  1. 模块的说明、函数的说明

  2. 关键数据结构说明

  3. 关键代码语句说明

  4. 对难以理解的算法说明

  5. 警示语(将来接手你代码的人)



  • c璇█婧愮▼搴忕殑娉ㄩ噴璇存槑浣嶄簬浠涔浣嶇疆?
    绛旓細寮澶达紝涓棿閮藉彲浠ョ殑杩欐槸姣旇緝甯歌鐨勩傚畠娌℃湁鍥哄畾鐨勪綅缃锛屽彧鏄湁鍥哄畾鐨勫啓娉曡屽凡锛屼笅闈細鏈夊垪鍒般傚師鍒欎笂鍙涓嶇牬鍧忓0鏄庡拰璇彞鐨勬剰鎬濆拰缁撴瀯锛屾斁鍦ㄥ摢閲岄兘鍙互锛屼絾鏄敞閲婂悗灏嗕笅涓鍙ュ垎鏍忥紝灏变笅闈㈠垪涓剧殑//杩欑绫诲瀷锛屼竴鑸彲浠ヨ蒋浠朵腑鐪嬪埌鐨勶紝姝e父璇彞鍜娉ㄩ噴鐨棰滆壊涓嶄竴鏍枫備緥濡傦紝涓嶈鏀惧湪瀹忕殑鍚岃锛屼笉瑕佹斁鍒 鎵撳嵃...
  • C璇█娉ㄩ噴鐨璇硶鏄庢牱鐨?
    绛旓細C璇█涓鏈変袱绉嶆敞閲婏紝鍏蜂綋璇存槑濡備笅锛1銆 /**/褰㈠紡銆傝繖绉嶆敞閲婃槸C鏈鏃╂敮鎸佺殑鍞竴鏂瑰紡锛屾敞閲婃涓轰竴涓潡锛屼互/*寮濮嬶紝鍒*/缁撴潫銆傝繖绉嶆敞閲婂彲浠ュ湪琛岄锛屽锛/* 娉ㄩ噴 */ int a=0;鍙互鍦ㄨ灏撅紝濡傦細int a=0;/* 娉ㄩ噴 */鍙互鍦ㄨ鍙ヤ腑闂达紝濡傦細int a=鍙互鏄琛屾敞閲婏紝濡傦細int a=0;/* 娉ㄩ噴娉ㄩ噴娉ㄩ噴...
  • 鍦ㄤ竴涓c婧愮▼搴忎腑,鍧楀紡娉ㄩ噴閮ㄥ垎浠ヤ粈涔堝紑濮
    绛旓細鍦C璇█婧愮▼搴忎腑锛屽潡寮娉ㄩ噴閮ㄥ垎浠/寮濮嬶紝浠/缁撴潫銆傚潡寮忔敞閲婏紝涔熺О涓哄琛屾敞閲婏紝鏄湪C鍜屽叾浠栫紪绋璇█涓甯歌鐨勪竴绉嶆敞閲婂舰寮忋傝繖绉嶇被鍨嬬殑娉ㄩ噴浠/寮濮嬶紝骞朵互/缁撴潫銆傚潡寮忔敞閲婂厑璁哥敤鎴峰湪娉ㄩ噴涓寘鍚琛屾枃鏈紝鍥犳寰楀悕鍧楀紡銆傚潡寮忚繖绉嶆敞閲婃柟寮忓彲浠ヨ法瓒婂琛岋紝鍏佽鍦ㄦ敞閲婁腑鍖呭惈澶嶆潅鐨勮鍙ユ垨娈佃惤銆傚綋缂栬瘧鍣ㄩ亣鍒/...
  • c璇█娉ㄩ噴鐨涓ょ褰㈠紡
    绛旓細鍦C璇█涓锛娉ㄩ噴鏈変袱绉嶅舰寮忥細鍗曡娉ㄩ噴鍜屽琛屾敞閲娿傚崟琛屾敞閲婁互“//”寮澶达紝鐩村埌璇ヨ缁撳熬銆傚畠浠彲浠ョ敤鏉ュ湪浠g爜涓坊鍔犱竴浜涙敞閲婃垨璇存槑銆備緥濡傦細int sum = 1 + 2; // 璁$畻1鍜2鐨勫拰 澶氳娉ㄩ噴浠“/*”寮澶达紝浠“*/”缁撳熬銆傚畠浠彲浠ョ敤鏉ユ敞閲婁竴娈垫垨澶氳浠g爜銆備緥濡傦細/*...
  • C璇█绋嬪簭鐨娉ㄩ噴閮ㄥ垎鍖呭惈鍦╛__鍜宊__涔嬮棿,涔熷彲鏀惧湪___涔嬪悗.
    绛旓細/*~~~*/涔嬮棿锛屼篃鍙斁鍦//鍚
  • c璇█涓殑娉ㄩ噴
    绛旓細6銆#include娉ㄦ剰锛氾紙1锛変互#鍙峰紑澶达紙2)涓嶄互鍒嗗彿缁撳熬杩欎竴琛屾病鏈夊垎鍙凤紝鎵浠ヤ笉鏄鍙ワ紝鍦c璇█涓绉颁箣涓哄懡浠よ锛屾垨鑰呭彨鍋氣滈缂栬瘧澶勭悊鍛戒护鈥濄7銆佺▼搴忎腑浠/*寮澶村苟涓斾互*/缁撳熬鐨勯儴鍒嗚〃绀虹▼搴忕殑娉ㄩ噴閮ㄥ垎锛屾敞閲婂彲浠ユ坊鍔犲湪绋嬪簭鐨勪换浣浣嶇疆锛屼负浜嗘彁楂樼▼搴忕殑鍙鎬ц屾坊鍔狅紝浣嗚绠楁満鍦ㄦ墽琛屼富鍑芥暟鍐呭鏃跺畬鍏ㄥ拷鐣ユ敞閲...
  • c璇█濡備綍娉ㄩ噴?
    绛旓細鍙互浣跨敤/*鍜*/鍒嗛殧绗︽潵鏍囨敞涓琛屽唴鐨娉ㄩ噴锛屼篃鍙互鏍囨敞澶氳鐨勬敞閲娿備緥濡傦紝鍦ㄤ笅鍒楃殑鍑芥暟鍘熷瀷涓紝鐪佺暐鍙风殑鎰忔濇槸 open() 鍑芥暟鏈夌涓変釜鍙傛暟锛屽畠鏄彲閫夊弬鏁般傛敞閲婅В閲婁簡杩欎釜鍙夊弬鏁扮殑鐢ㄦ硶锛歩nt open( const char *name, int mode, 鈥 /* int permissions */ )锛涗唬鐮佸叿鏈夎緝濂界殑鍙Щ妞嶆 C璇█鏄...
  • c璇█娉ㄩ噴绗﹀彿鏄粈涔?
    绛旓細Comment锛C璇█鐨勬敞閲绗︿互鈥/*鈥濆紑澶村苟浠モ*/鈥濈粨灏剧殑涓层傚湪鈥/*鈥濆拰鈥*/鈥濅箣闂寸殑鍗充负娉ㄩ噴銆傜▼搴忕紪璇戞椂锛屼笉瀵规敞閲婁綔浠讳綍澶勭悊銆傛敞閲婂彲鍑虹幇鍦ㄧ▼搴涓殑浠讳綍浣嶇疆銆傛敞閲婄敤鏉ュ悜鐢ㄦ埛鎻愮ず鎴栬В閲婄▼搴忕殑鎰忎箟銆傚湪璋冭瘯绋嬪簭涓鏆備笉浣跨敤鐨勮鍙ヤ篃鍙敤娉ㄩ噴绗︽嫭璧锋潵锛屼娇缈昏瘧璺宠繃涓嶄綔澶勭悊锛屽緟璋冭瘯缁撴潫鍚庡啀鍘绘帀娉ㄩ噴绗...
  • c璇█绋嬪簭鐨娉ㄩ噴鍙互鍑虹幇鍦ㄧ▼搴忕殑浠讳綍鍦版柟,涓涓敞閲婁互浠涔堜綔涓哄紑濮嬪拰缁...
    绛旓細娉ㄩ噴浠/*寮濮 */缁撴潫锛屽鏋滀互//娉ㄩ噴锛屽垯鍦ㄦ湰琛屾湯灏剧粨鏉
  • c璇█涓殑娉ㄩ噴涓嶅彲浠ュ姞鍦ㄥ彉閲忓悕鎴栧叧閿瓧鐨勪腑闂 杩欏彞璇濆鍚?
    绛旓細瀵广備笉鍙互鍔犲湪鍙橀噺鍚嶆垨鍏抽敭瀛楃殑涓棿锛屼絾鍙互鍔犲湪涓や釜鍙橀噺鍚嶆垨鍏抽敭瀛楃殑涓棿銆俰nt /*娉ㄨВ*/ data; 娌¢棶棰 i /*娉ㄨВ*/nt data;灏变笉琛屼簡
  • 扩展阅读:c语言注释有哪几种 ... c语言注释的两种方法 ... c语言中怎么注释 ... 强制转换c语言 ... c语言加注释的软件 ... c语言双斜杠注释 ... c语言注释符号 ... c语言怎么加注释 ... c语言快捷注释 ...

    本站交流只代表网友个人观点,与本站立场无关
    欢迎反馈与建议,请联系电邮
    2024© 车视网