美文网首页
代码书写规范

代码书写规范

作者: Blacol | 来源:发表于2020-02-20 17:17 被阅读0次

声明:

为了便于浏览,本文章所用的代码是简化后的结果

适当的注释

注释是非常重要的。注释可以帮助你或者你的同事亦或是你的同学去解读这块儿代码。当多人协作时,代码也可以用来当做批注。

有时候在编写程序的时候可能不会写注释,因为你觉得它太简单。但是,当你写了成千上万行代码后,如果你一个注释都没写,那你会很头疼。

所以,注释是很重要的

缩进

什么是缩进呢?
看下面两段代码:

//没使用缩进
main(){
int a;
char b;
int c;
if(a>15){
b=b+c;
c=b+c;
}else if(a<=15){
c=a+c;
b=a*c;
}
}
//使用缩进
main(){
  int a;
  char b;
  int c;
  if(a>15){
    b=b+c;
    c=b+c;
  }else if(a<=15){
    c=a+c;
    b=a*c;
  }
}

上面的2段代码您看哪个更舒服?

缩进可以让代码的结构更加清晰,能找到所属的部分进而便于查找错误。

没有缩进会使代码没有层次感,调试进展的也不会很好。

缩进使用tab键就可以。当然,现在主流的一些编译器会自动帮你完成缩进,不需要你一个一个敲。

正确的语法

有时候在调试时会看到这一段话:

xxx errors,0 warning

或者是

xxx 错误,0 警告

出现这句话之后,你的程序就打不开了,也调试不了。

那个错误就是导致你无法调试你的程序的元凶。

那些个错误是咋来的呢?

  1. 语法有错误
    你的语法结构部标准会导致一些错误,比如大小写,中英文符号,缺了括号等等错误。初学c语言的同学可能会忘记引用头文件等等。要想解决这些错误就需要你把基础语法知识学明白,关键字,符号,参数等等都要记牢。

  2. 一些小问题导致的错误
    有时候,发现错误然后回看代码时会发现这个地方明明没有错误但为什么还是会报错呢?

其实那个地方有错误,只是你没看见或者你没有想到这个关键字的一些注意事项。比如某个关键字只接受整形数据而你将字符型数据给了这个关键字,这就导致了出错。

这种错误需要多敲,多练习,渐渐地,这些关键字的隐藏用法和注意事项你就能发现了。

  1. 编译器本身的错误
    有时候编译器抽风,明明代码写的都对然后就是报错,报错了,还不知道具体位置是哪里。这就是编译器自身的问题。可以试试重装编译器

  2. 编译器本身的一些语法限制导致的错误
    一些编译器可能采用了不同的语法标准或者编译器机制不同导致一些语法看似正确但在这个编译器里就是错的这样的问题。比如vs2019中,当你用c++语言编写程序时,使用int它会报错,提示“int默认为int,c++中不支持int”(好像是这样)。

一些编译器会提供解决方案,你可以去这些编译器的官方网站去寻找答案或者自己探索来规避这个错误。

正确的逻辑结构

有时候,你的程序的运行结果不符合你的预期,编译器也没有报错,检查代码也没有发现语法错误。这时候你就需要考虑逻辑结构是否出现错误。比如:你想计算两个数的和,那两个数让用户自己输入:

main(){
  int a;
  int b;
  printf("%d",a+b);
  scanf("%d",&a);
  scanf("%d",&b);
}

结果是一串数字,可能是1455也可能是99999999。
这时你需要更改你的代码:

main(){
  int a;
  int b;
  scanf("%d",&a);
  scanf("%d",&b);
  printf("%d",a+b);
}

这样结果才能正确。

因此,在写代码的时候要有正确的逻辑。就比如上面的程序,我应该先让用户输入数字才能进行计算,所以应该将输入的语句放在输出语句前面。

还有一种情况就是你忽略了小数部分或者是一些符号。初学者最常见的是想要小数结果但最后输出的是整数或者是0等等。

这些错误其实是忽略细节和语法不扎实造成的。

所以,一定要学好语法,一定要细心。

相关文章

  • 代码书写规范

    HTML是描述网页结构的超文本标记语言,HTML规范能够使HTML代码风格保持一致,使得HTML更容易理解和维护。...

  • 书写代码规范

    通过分析github代码库总结出来的工程师代码书写习惯 使用英文小写 别忘记结束符 嵌套注意层层缩进标签,缩进使用...

  • 代码书写规范

    res命名规范: src中命名规范: 习惯命名:

  • 代码书写规范

    声明: 为了便于浏览,本文章所用的代码是简化后的结果 适当的注释 注释是非常重要的。注释可以帮助你或者你的同事亦或...

  • 乐乎-代码规范概述

    参考: 1、iOS中书写代码规范35条小建议 2、iOS开发总结之代码规范 3、iOS代码编程规范-根据项目经验汇...

  • 前端规范

    前端规范 规范说明 此为前端开发团队遵循和约定的代码书写规范,意在提高代码的规范性和可维护性。此规范为参考规范,统...

  • java代码书写规范

    1、"常量".equals("变量") //因为变量可能为null,如果放在前面的话,会抛出异常 2、if(nul...

  • iOS 代码书写规范

    self.和下划线访问的区别 self.会使引用计数加一,而_xx不会使用引用计数加一的。所以使用self.xxx...

  • iOS代码书写规范

    /////////////////////////////////////////////////////////...

  • Android代码书写规范

    1、一个顶级类(只有一个) 2、使用图片类要显式回收 3、数据库和cursor要显式close 4、对象的引用在不...

网友评论

      本文标题:代码书写规范

      本文链接:https://www.haomeiwen.com/subject/bubxqhtx.html