ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

双人项目 代码规范的理解

2020-10-19 23:02:09  阅读:198  来源: 互联网

标签:运算符 缩进 代码 规范 空格 注释 对齐 双人


该课程的双人项目是与任时瑶同学一起合作的,我们通过阅读老师发出来的书,以及结合网上资料总结出以下一些要点,代码规范基本体现在空行、空格、成对书写、缩进、对齐、代码行、注释七方面的书写规范上。

1) 空行

      • 两个相对独立的程序块、变量说明之后必须要加空行。比如上面几行代码完成的是一个功能,下面几行代码完成的是另一个功能,那么它们中间就要加空行。这样看起来更清晰。

2) 空格

      • 关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格,否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号(,以突出关键字。
      • 函数名之后不要留空格,应紧跟左括号(,以与关键字区别。
      • (向后紧跟;)、,、;这三个向前紧跟;紧跟处不留空格。
      • 之后要留空格。如果;不是一行的结束符号,其后要留空格。
      • 赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符,如 =、==、!=、+=、-=、*=、/=、%=、>>=、<<=、&=、^=、|=、>、<=、>、>=、+、-、*、/、%、&、|、&&、||、<<、>>、^ 等双目运算符的前后应当加空格。
      • 同时,运算符“%”是求余运算符,与 printf 中 %d 的“%”不同,所以 %d 中的“%”前后不用加空格。
      • 单目运算符 !、~、++、--、-、*、& 等前后不加空格。
      • 像数组符号[]、结构体成员运算符.、指向结构体成员运算符->,这类操作符前后不加空格。
      • 对于表达式比较长的 for 语句和 if 语句,为了紧凑起见,可以适当地去掉一些空格。但 for 和 if 后面紧跟的空格不可以删,其后面的语句可以根据语句的长度适当地去掉一些空格。
      • for 和分号后面保留空格就可以了,=和<前后的空格可去掉。

3) 成对书写

      • 成对的符号一定要成对书写,如 ()、{}。不要写完左括号然后写内容最后再补右括号,这样很容易漏掉右括号,尤其是写嵌套程序的时候。

4) 缩进

      • 缩进是通过键盘上的 Tab 键实现的,缩进可以使程序更有层次感。原则是:如果地位相等,则不需要缩进;如果属于某一个代码的内部代码就需要缩进。

5) 对齐

    • 对齐主要是针对大括号{}说的:
    • {和}分别都要独占一行。互为一对的{和}要位于同一列,并且与引用它们的语句左对齐。
    • {}之内的代码要向内缩进一个 Tab,且同一地位的要左对齐,地位不同的继续缩进。
    • 写完 if 那一行后,按回车,此时光标在括号的右边,而此 if 下的大括号要写在与 if 左对齐的正下方,通常我们是按一下 Backspace 键使光标停在与 if 左对齐的正下方。但事实上我们不需要这样做,我们直接输入大括号即可,系统会自动对齐到与 if 左对齐的正下方。

6) 代码行

      • 一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且便于写注释。
      • if、else、for、while、do 等语句自占一行,执行语句不得紧跟其后。此外,非常重要的一点是,不论执行语句有多少行,就算只有一行也要加{},并且遵循对齐的原则,这样可以防止书写失误。

7) 注释

      • 注释通常用于重要的代码行或段落提示。在一般情况下,源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码,但注意不可过多地使用注释。
      • 注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多会让人眼花缭乱。
      • 如果代码本来就是清楚的,则不必加注释。
      • 边写代码边注释,修改代码的同时要修改相应的注释,以保证注释与代码的一致性,不再有用的注释要删除。
      • 当代码比较长,特别是有多重嵌套的时候,应当在段落的结束处加注释,这样便于阅读。
      • 每一条宏定义的右边必须要有注释,说明其作用。

    通过阅读,让我们认识到代码规范的重要性。在以后的代码编写时,规范统一的代码编译,提高代码可读性,在换人以及团队编译时依旧可以接续上,不会存在理解问题而且易懂易读,在后续的学习过程中更应该去加强自己的规范意识,不断提高自己。

 

标签:运算符,缩进,代码,规范,空格,注释,对齐,双人
来源: https://www.cnblogs.com/kodaira/p/13843789.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有