注释是对代码的“提示”,而不是文档

Posted borter

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了注释是对代码的“提示”,而不是文档相关的知识,希望对你有一定的参考价值。

注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主, 注释太多了会让人眼花缭乱。注释的花样要少。

 

 1 #include <iostream>
 2 #include<stdlib.h>
 3 
 4 /* run this program using the console pauser or add your own getch, system("pause") or input loop */
 5 using namespace std;
 6 int main(int argc, char** argv) {
 7         //声明变量
 8     char ch;
 9     char str[20];
10     int n;
11     float x;
12 
13     //用stdin从键盘上输入数据
14     fprintf(stdout,"ch str
");
15     fscanf(stdin,"%c %s",&ch,str);
16     fprintf(stdout,"n    x 
");
17     fscanf(stdin,"%d  %f",&n,&x);
18     cout<<"----------------"<<endl;
19 
20     //输出显示
21     fprintf(stdout,"ch=%c str=%s",ch,str);
22     fprintf(stdout,"
n=%d x=%f",n,x);
23     cout<<endl;
24     return 0;
25 }

 

以上是关于注释是对代码的“提示”,而不是文档的主要内容,如果未能解决你的问题,请参考以下文章

Kotlin自定义注释,参数

PHP 类型提示 - 代码与注释

vscode 删除注释代码 有没有类似插件 清理所有注释?

片段 getActivity 不起作用

使用 OpenGL C++ 渲染到纹理

代码规范