c语言中注释的位置
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了c语言中注释的位置相关的知识，希望对你有一定的参考价值。
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 //.\\n" );
2、预处理器仅通过检查注释的结束符来检测注释中的字符，因此，不能嵌套块注释。然而，可以使用/*和*/注释包含单行注释的源代码：
/* 暂时注释掉这两行：
const double pi = 3.1415926536; // pi是一个常量
area = pi * r * r; // 计算面积
暂时注释到此 */
参考技术A 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)注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达——注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。 参考技术B 变量、保留字的字符之间不能有注释其他任何位置都可以加注释
包括：
一、单独一行可以在任何位置
二、与其他语句在一行，可以在末尾
三、在一行的首位置
四、在中间的任意位置
当然这里的注释是指/* */这样的有界限的不是//这样的注释，//只使用与第一二两种情况。追问
那你选什么啊
追答用/* */自由点
本回答被提问者采纳 参考技术C 一般来讲有两种：一是单行注释：直接在该行需要注释的地方加上"//"就行了。例如：
"int a,b;//这是一个注释行"。那么，"//"后面的部分"这是一个注释行"就被注释掉了，不起作用，但是"//"前面的“int a,b;"不受影响。
另外还有一种是多行同时注释：
/*
int a,b;
int c,d;
*/
其中"/*"和"*/"起限定范围的作用，该范围内的语句都会被注释掉，将不再起作用。当然，多行注释也是可以用来单行注释的 参考技术D
首先通过精心设计的数据结构、恰当的函数和变量命名以及良好的代码缩进，使得别人可以读代码就能理解程序的用意，把注释降低到最低。因为满篇的注释可能恰恰暴露了你的程序设计的不合理。但有一些注释是必须要的：
模块的说明、函数的说明
关键数据结构说明
关键代码语句说明
对难以理解的算法说明
警示语（将来接手你代码的人）
注释转换——（小项目）
一门计算机语言如果想要运用的得心应手，离不开长久的练习，针对C语言的用法，下面主要是用C语言来解决注释转换的问题，C语言中注释是以”/*”开始，以”*/”结束，C++语言中可以通过”//”来注释，这里不考虑C++语言向下兼容C语言的特点，主要是想将”/* */”注释符转换为”// ”。对于各种的注释情况，程序中能够实现各种各样的注释能够进行转换。
以下是一般人在编写程序时“注释”的各种情况，这里的情况可能不够完整，需要以后碰见其他的情况来对程序进行修改和补充。
// 1.一般情况 /* int i = 0; */ // 2.换行问题 /* int i = 0; */int j = 0; /* int i = 0; */ int j = 0; // 3.匹配问题 /*int i = 0;/*xxxxx*/ // 4.多行注释问题 /* int i=0; int j = 0; int k = 0; */int k = 0; // 5.连续注释问题 /**//**/ // 6.连续的**/问题 /***/ // 7.C++注释问题 // /*xxxxxxxxxxxx*/ // 8.C注释本身不匹配 /* int i = 0;
下面是具体的程序代码：
#pragma once
#include <assert.h>
#include <errno.h>
typedef enum State //解决匹配问题 /*int i = 0;/*int j = 0;*/
{
C_Start,
C_End,
};
void convert(FILE * fin, FILE * fout) //针对各种的注释进行转换
{
char first, second;
assert(fin);
assert(fout);
State tag = C_End;
do
{
first = fgetc(fin); //fgetc函数的功能是读取字符
switch (first)
{
case ‘/‘: //解决/*int i = 0;*/
second = fgetc(fin);
if (second == ‘*‘)
{
if (tag == C_End)
{
fputc(‘/‘, fout);
fputc(‘/‘, fout);
tag = C_Start;
}
else
{
fputc(‘/‘, fout);
fputc(‘*‘, fout);
}
}
else if (second == ‘/‘)
{
char next;
fputc(first, fout);
fputc(second, fout);
//解决c++注释嵌套c注释的问题
do
{
next = fgetc(fin);
fputc(next, fout);
if (next == EOF) //解决c++注释后面多写EOF的情况
{
return;
}
}while (next != ‘\n‘);
}
else
{
fputc(first, fout);
fputc(second, fout);
}
break;
case ‘\n‘:
//处理多行注释问题
fputc(‘\n‘, fout);
if (tag == C_Start)
{
fputc(‘/‘, fout);
fputc(‘/‘, fout);
}
break;
case ‘*‘:
second = fgetc(fin);
if (second == ‘/‘)
{
char next = fgetc(fin);
//处理连续注释问题
if (next == ‘/‘)
{
fputc(‘\n‘, fout);
fseek(fin, -1, SEEK_CUR);
//fseek函数是将fin指针进行向前移位，具体的功能查文档进行解答
}
else if (next != ‘\n‘ && next != EOF) //解决/*int i = 0;*/int j = 0;
{
fputc(‘\n‘, fout);
fputc(next, fout);
}
else
{
//解决/*int i = 0;*/ /n int j = 0;
fputc(‘\n‘, fout);
}
tag = C_End;
}
else if (second == ‘*‘)
{
fputc(‘*‘, fout);
fseek(fin, -1, SEEK_CUR);
}
else
{
fputc(first, fout);
fputc(second, fout);
}
break;
default:
fputc(first, fout); //将first读取的字符串写入fout指定的文件中
break;
}
} while (first != EOF);
}
void Annotation(const char * inputFile, const char * outputFile)
{
FILE * Fin, * Fout; //定义两个文件指针
Fin = fopen(inputFile, "r"); //“r”表示读操作
if (Fin == NULL)
{
printf("打开文件%s失败！errno:%d\n", inputFile, errno);
return;
}
Fout = fopen(outputFile, "w"); //"w"表示写操作
if (Fout == NULL)
{
fclose(Fin); //fclose关闭文件
printf("打开文件%s失败！errno:%d\n", outputFile, errno);
return;
}
convert(Fin, Fout);
fclose(Fin);
fclose(Fout);
}本文出自 “无心的执着” 博客，谢绝转载！
以上是关于c语言中注释的位置的主要内容，如果未能解决你的问题，请参考以下文章