• 《手把手教你学C语言》学习笔记(4)---代码规范


    编程过程中需要遵守编译器的各种约定,例如以下代码:
    
     1 #include <stdio.h>
     2 
     3 int main(int argc, char **argv)
     4 {
     5     printf("Hello World!
    ");
     6 
     7     return 0;                                                     
     8 }
    无论多么简单的程序,必须能够通过编译的检查和编译,否则就不能运行。也就是说代码需要遵从编程语言的语法规则。我们说的代码规范,只是一种约定俗成,会让你的代码更容易阅读和调试,让你更容易进入下一个编程境界。
    下面说下代码的规范,算是个简单入门吧!
    
    1. 空行的应用规范:(1)、变量(群)定义后需要加上一个空行;(2)、内部函数实现的前后需要各加一个空行;(3)、return语句前面需要加一个空行;(4)、#include语句后需要加一个空行;(5)、代码逻辑功能完整后需要添加一个空行。
    2. 空格的应用规范:(1)、关键字后要加一个空格;(2)、函数名与‘(’之间不要加空格;(3)、‘,’、‘;’、‘)’、‘]’和‘}’之前不要加空格;(4)、‘,’之后加一个空格;(5)、双目运算符的前后需要各加一个空格;(6)、单目运算符前后不加空格;(7)、‘[]’数组符号、‘.’成员运算符与‘->结构体指针成员运算符’等前后不加空格。
    3. 注释的应用规范:(1)、一般要求注释量不低于源代码的30%;(2)、注释分为单行注释和多行注释,简单注释时采用单行注释;(3)、注释主要用来理解代码,不能用来画蛇添足;(4)、注释必须在写代码的过程中书写,修改代码的同时,相关的注释也必须一并修改;(5)、多重嵌套的开始处需要添加适当的注释;(6)、每条宏定义需要添加注释;(7)、每个方法(函数)前面需要添加注释,内容包括方法的返回值的意义,方法需要的参数值及方法的作用,有时需要添加上版权信息。
    4. 代码行的应用规范:(1)、原则上一行代码只做一件事情,还而言之只写一条语句;(2)、语句块需要加上{},即使该语句块只有一条语句,并且语句块中的代码,根据逻辑不同添加不同的空行和实现不同的对齐;(3)、成对符号的书写,最好在写完左半部分后就及时补上右半部分,避免漏写右半部分;(4)、{}的对齐,需要位于不同的行,但必须位于同一列;(5)、{}内的代码同等地位需要左对齐,不同地位的需要继续向右缩进,一次向右缩进一个层次;(6)、缩进一般通过键盘的tab键实现,每按一次按键增加一个缩进层次,通过不同的缩进使程序代码显得更加有层次感,便于代码的阅读和理解。
      代码的规范其实有很多,但是不是必须的,只是为了让代码更整齐,更悦目,更容易阅读和理解而建立起来的一套规范,对初学者来说,不需要刻意去记忆这些编码的规范,但是可以通过多次敲写代码,大量的联系,不停的积累,以后写代码就会慢慢的形成自己的规范了。建议初学者可以使用适当的工具,个人不建议使用IDE开发工作,如果只是C语言,强烈建议使用VIM编辑器,外加Gcc编译器和Gdb调试器和make自动编译工作,比任何一个IDE功能更加强大,使用更加灵活,让你的学习更加深入。
  • 相关阅读:
    面向对象之继承
    面向对象之封装
    面向对象编程
    Centos7.7镜像源配置
    Centos7环境配置
    多表查询v1
    多表查询
    库相关操作
    数据库初识
    数据相关操作
  • 原文地址:https://www.cnblogs.com/guochaoxxl/p/6823091.html
Copyright © 2020-2023  润新知