如果代码本来就是清楚的,则不必加注释

Posted borter

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了如果代码本来就是清楚的,则不必加注释相关的知识,希望对你有一定的参考价值。

如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。 例如 i++; // i 加 1,多余的注释

 

 1 #include <iostream>
 2 #include <stdio.h>
 3 /* run this program using the console pauser or add your own getch, system("pause") or input loop */
 4 using namespace std;
 5 int main(int argc, char** argv) {
 6         int c;
 7     /* Create an error by writing to standard input. */
 8     putc( A, stdin );
 9     if( ferror( stdin ) )
10     {
11       perror( "Write error" );
12       clearerr( stdin );
13     }
14 
15     /* See if read causes an error. */
16     printf( "Will input cause an error? " );
17     c = getc( stdin );
18     if( ferror( stdin ) )
19     {
20        perror( "Read error" );
21        clearerr( stdin );
22     }
23     return 0;
24 }

 

以上是关于如果代码本来就是清楚的,则不必加注释的主要内容,如果未能解决你的问题,请参考以下文章

怎么给代码加注释?

在json中使用注释

idea里怎么快速给函数加注释

当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释

MyEclipse方法名加注释

SQL 如何给字段名加注释