编码规范_编码规范的意义 - CSDN
精华内容
参与话题
  • 【代码规范】常见编码规范

    万次阅读 2018-06-26 16:27:31
    文章来源:公众号-智能化IT系统。1.明确方法功能,精确(而不是近似)地实现方法设计。如果一个功能将在多处实现,即使只有两行代码,也应该编写方法实现。说明:虽然为仅用一两行就可完成的功能去编方法好象没有...

    文章来源:公众号-智能化IT系统。


    1.明确方法功能,精确(而不是近似)地实现方法设计。如果一个功能将在多处实现,即使只有两行代码,也应该编写方法实现。

    说明:

    虽然为仅用一两行就可完成的功能去编方法好象没有必要,但用方法可使功能明确化,增加程序可读性,亦可方便维护、测试。

     

    2.应明确规定对接口方法参数的合法性检查应由方法的调用者负责还是由接口方法本身负责,缺省是由方法调用者负责。

    说明:

    对于模块间接口方法的参数的合法性检查这一问题,往往有两个极端现象,即:要么是调用者和被调用者对参数均不作合法性检查,结果就遗漏了合法性检查这一必要的处理过程,造成问题隐患;要么就是调用者和被调用者均对参数进行合法性检查,这种情况虽不会造成问题,但产生了冗余代码,降低了效率。

     

    3.明确类的功能,精确(而不是近似)地实现类的设计。一个类仅实现一组相近的功能。说明:划分类的时候,应该尽量把逻辑处理、数据和显示分离,实现类功能的单一性。

    示例:

    数据类不能包含数据处理的逻辑。通信类不能包含显示处理的逻辑。

     

    4.所有的数据类必须重载toString() 方法,返回该类有意义的内容。说明:父类如果实现了比较合理的toString() , 子类可以继承不必再重写。

    示例:

    public TopoNode
     {
         private String nodeName;
         public String toString()
          {
             return "NodeName : " +  nodeName;
          }
     }

     

    5.数据库操作、IO操作等需要使用结束close()的对象必须在try -catch-finally finallyclose()


    6.异常捕获后,如果不对该异常进行处理,则应该记录日志(针对后台)。

    说明:若有特殊原因必须用注释加以说明。


    7.自己抛出的异常必须要填写详细的描述信息。

    说明:便于问题定位。

    示例:

    throw  new IOException("Writing data error! Data: " + data.toString());

     

    8. 在程序中使用异常处理还是使用错误返回码处理,根据是否有利于程序结构来确定,并且异常和错误码不应该混合使用,推荐使用异常。说明:一个系统或者模块应该统一规划异常类型和返回码的含义。但是不能用异常来做一般流程处理的方式,不要过多地使用异常,异常的处理效率比条件分支低,而且异常的跳转流程难以预测。

     

    9.避免使用不易理解的数字,用有意义的标识来替代。涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的静态变量来代替。
    示例:

    如下的程序可读性差

    if  (state == 0)

    {

    state = 1;

    ... // program  code

    }

    应改为如下形式

    private final static int  TRUNK_IDLE = 0;
     private final static int TRUNK_BUSY = 1;
     private final static int TRUNK_UNKNOWN = -1;
     
     

    if (state == TRUNK_IDLE)

    {
         state = TRUNK_BUSY;
         ... // program code

    }

     

    10.数组声明的时候使用 int[] index ,而不要使用 int index[] 。说明:

     

    11.异常捕获尽量不要直接 catch (Exception ex) ,应该把异常细分处理。


    12.不要使用难懂的技巧性很高的语句,除非很有必要时。说明:高技巧语句不等于高效率的程序,实际上程序的效率关键在于算法。


    公众号-智能化IT系统。每周都有技术文章推送,包括原创技术干货,以及技术工作的心得分享。扫描下方关注。



    公众号-智能化IT系统。每周都有技术文章推送,包括原创技术干货,以及技术工作的心得分享。扫描下方关注。

    展开全文
  • 华为编码规范 JAVA 华为编码规范 JAVA 华为编码规范 JAVA 华为编码规范 JAVA 华为编码规范 JAVA 华为编码规范 JAVA
  • 11条最全面的C/C++编码规范总结

    万次阅读 2018-05-11 15:46:54
    每个公司基本都有自己的编程风格,每个人也有各自的偏好,这篇文章的很多规则个人用的比较习惯转需:https://blog.csdn.net/zang141588761/article/details/50608736对于不同的编程语言来说,具体的编码规范可以有很...

    每个公司基本都有自己的编程风格,每个人也有各自的偏好,这篇文章的很多规则个人用的比较习惯

    转需:https://blog.csdn.net/zang141588761/article/details/50608736

    对于不同的编程语言来说,具体的编码规范可以有很大的不同,但是其宗旨都是一致的,就是保证代码在高质量完成需求的同时具备良好的可读性、可维护性。例如我们可以规定某个项目的C语言程序要遵循这样的规定:变量的命名,头文件的书写和#include 等等。

    下面是一些广为采用的编码规范:

      • GNU Coding Standards
      • Guidelines for the Use of the C Language in Vehicle Based Software
      • C++ Coding Guidelines
      • SUN Code Conventions for Java

    以下是一些介绍编码、编码规范的书籍:

      • C++编码规范,陈世忠,人民邮电出版社,2002
      • 高质量程序设计指南:C++/C语言,林锐等,电子工业出版社,2003

    :以下只是根据课题组已有的经验给出的总结,并非对所有场景均适用。

    对于高质量的工程,一般会做到:

      1.代码简洁精炼,美观,可读性好,高效率,高复用,可移植性好,高内聚,低耦合,没有冗余,不符合这些原则,必须特别说明。
      2.规范性,代码有规可循。特殊排版、特殊语法、特殊指令,必须特别说明。

    一、文件排版方面


    1. 包含头文件

     • 先系统头文件,后用户头文件。
     • 系统头文件,稳定的目录结构,应采用包含子路径方式。
     • 自定义头文件,不稳定目录结构,应在dsp中指定包含路径。
     • 系统头文件应用:#include <xxx.h>
     • 自定义同文件应用:#include "xxx.h"
     • 只引用需要的头文件。

    2. h和cpp文件

     • 头文件命名为.h,内联文件命名为.inl;C++文件命名为*.cpp
     • 文件名用大小写混合,或者小写混合。例如DiyMainview.cppinfoview.cpp。不要用无意义的名称:例如XImage.cppSView.cppxlog.cpp
     • 头文件除了特殊情况,应使用#ifdef控制块。
     • 头文件#endif应采用行尾注释。
     • 头文件,首先是包含代码块,其次是宏定义代码块,然后是全局变量,全局常量,类型定义,类定义,内联部分。
     • CPP文件,包含指令,宏定义,全局变量,函数定义。

    3. 文件结构

     • 文件应包含文件头注释和内容。
     • 函数体类体之间原则上用2个空行,特殊情况下可用一个或者不需要空行。

    4. 空行

     • 文件头、控制块,#include部分、宏定义部分、class部分、全局常量部分、全局变量部分、函数和函数之间,用两个空行。

    二、注释方面


    1. 文件头注释

     • 作者,文件名称,文件说明,生成日期(可选)

    2. 函数注释

     • 关键函数必须写上注释,说明函数的用途。
     • 特别函数参数,需要说明参数的目的,由谁负责释放等等。
     • 除了特别情况,注释写在代码之前,不要放到代码行之后。
     • 对每个#else#endif给出行末注释。
     • 关键代码注释,包括但不限于:赋值,函数调用,表达式,分支等等。
     • 善未实现完整的代码,或者需要进一步优化的代码,应加上 // TODO …
     • 调试的代码,加上注释 // only for DEBUG
     • 需要引起关注的代码,加上注释 // NOTE …
     • 对于较大的代码块结尾,如for,while,do等,可加上 // end for|while|do

    三、命名方面


    1. 原则

     • 同一性:在编写一个子模块或派生类的时候,要遵循其基类或整体模块的命名风格,保持命名风格在整个模块中的同一性。
     • 标识符组成:标识符采用英文单词或其组合,应当直观且可以拼读,可望文知意,用词应当准确,避免用拼音命名。
     • 最小化长度 && 最大化信息量原则:在保持一个标识符意思明确的同时,应当尽量缩短其长度。
     • 避免过于相似:不要出现仅靠大小写区分的相似的标识符,例如"i"与"I""function""Function"等等。
     • 避免在不同级别的作用域中重名:程序中不要出现名字完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但容易使人误解。
     • 正确命名具有互斥意义的标识符:用正确的反义词组命名具有互斥意义的标识符,如:"nMinValue" 和"nMaxValue""GetName()" 和"SetName()" ….
     • 避免名字中出现数字编号:尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)。

    2. T,C,M,R类

     • T类表示简单数据类型,不对资源拥有控制权,在析构过程中没有释放资源动作。
     • C表示从CBase继承的类。该类不能从栈上定义变量,只能从堆上创建。
     • M表示接口类。
     • R是资源类,通常是系统固有类型。除了特殊情况,不应在开发代码中出现R类型。

    3. 函数名

     • M类的函数名称应采用HandleXXX命名,例如:HandleTimerEvent;不推荐采用java风格,例如handleTimerEvent;除了标准c风格代码,不推荐用下划线,例如,handle_event
     • Leave函数,用后缀L。
     • Leave函数,且进清除栈,用后缀LC。
     • Leave函数,且删除对象,用后缀LD。

    4. 函数参数

     • 函数参数用a作为前缀。
     • 避免出现和匈牙利混合的命名规则如apBuffer名称。用aBuffer即可。
     • 函数参数比较多时,应考虑用结构代替。
     • 如果不能避免函数参数比较多,应在排版上可考虑每个参数占用一行,参数名竖向对齐。

    5. 成员变量

     • 成员变量用m最为前缀。
     • 避免出现和匈牙利混合的命名规则如mpBuffer名称。用mBuffer即可。

    6. 局部变量

     • 循环变量和简单变量采用简单小写字符串即可。例如,int i;
     • 指针变量用p打头,例如void* pBuffer;

    7. 全局变量

     • 全局变量用g_最为前缀。

    8. 类名

     • 类和对象名应是名词。
     • 实现行为的类成员函数名应是动词。
     • 类的存取和查询成员函数名应是名词或形容词。

    9. 风格兼容性

     • 对于移植的或者开源的代码,可以沿用原有风格,不用C++的命名规范。

    四、代码风格方面

    1. Tab和空格

     • 每一行开始处的缩进只能用Tab,不能用空格,输入内容之后统一用空格。除了最开始的缩进控制用Tab,其他部分为了对齐,需要使用空格进行缩进。这样可以避免在不同的编辑器下显示不对齐的情况。
     • 在代码行的结尾部分不能出现多余的空格。
     • 不要在"::","->","."前后加空格。
     • 不要在",",";"之前加空格。

    2. 类型定义和{

     • 类,结构,枚举,联合:大括号另起一行

    3. 函数

     • 函数体的{需要新起一行,在{之前不能有缩进。
     • 除了特别情况,函数体内不能出现两个空行。
     • 除了特别情况,函数体内不能宏定义指令。
     • 在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。
     • 在头文件定义的inline函数,函数之间可以不用空行,推荐用一个空行。

    4. 代码块

     • "if"、"for"、"while"、"do"、"try"、"catch" 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加 “{ }” 。这样可以防止书写和修改代码时出现失误。
     • "if"、"for"、"while"、"do"、"try"、"catch" 的括号和表达式,括号可紧挨关键字,这样强调的是表达式。

    5. else

    • if语句如果有else语句,用 } else { 编写为一行,不推荐用 3 行代码的方式。

    6. 代码行

     • 一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
     • 多行变量定义,为了追求代码排版美观,可将变量竖向对齐。
     • 代码行最大长度宜控制在一定个字符以内,能在当前屏幕内全部可见为宜。

    7. switch语句

     • case关键字应和switch对齐。
     • case子语句如果有变量,应用{}包含起来。
     • 如果有并列的类似的简单case语句,可考虑将case代码块写为一行代码。
     • 简单的case之间可不用空行,复杂的case之间应考虑用空行分割开。
     • case字语句的大括号另起一行,不要和case写到一行。
     • 为所有switch语句提供default分支。
     • 若某个case不需要break一定要加注释声明。

    8. 循环

     • 空循环可用 for( ;; ) 或者 while( 1 ) 或者 while( true )

    9. 类

     • 类继承应采用每个基类占据一行的方式。
     • 单继承可将基类放在类定义的同一行。如果用多行,则应用Tab缩进。
     • 多继承在基类比较多的情况下,应将基类分行,并采用Tab缩进对齐。
     • 重载基类虚函数,应在该组虚函数前写注释 // implement XXX
     • 友元声明放到类的末尾。

    10. 宏

     • 不要用分号结束宏定义。
     • 函数宏的每个参数都要括起来。
     • 不带参数的宏函数也要定义成函数形式。

    11. goto

     • 尽量不要用goto

    五、类型


    • 定义指针和引用时*和&紧跟类型。
    • 尽量避免使用浮点数,除非必须。
    • 用typedef简化程序中的复杂语法。
    • 避免定义无名称的类型。例如:typedef enum { EIdle, EActive } TState;
    • 少用union,如果一定要用,则采用简单数据类型成员。
    • 用enum取代(一组相关的)常量。
    • 不要使用魔鬼数字。
    • 尽量用引用取代指针。
    • 定义变量完成后立即初始化,勿等到使用时才进行。
    • 如果有更优雅的解决方案,不要使用强制类型转换。

    六、表达式


    • 避免在表达式中用赋值语句。
    • 避免对浮点类型做等于或不等于判断。
    • 不能将枚举类型进行运算后再赋给枚举变量。
    • 在循环过程中不要修改循环计数器。
    • 检测空指针,用 if( p )
    • 检测非空指针,用 if( ! p )

    七、函数


    1. 引用

     • 引用类型作为返回值:函数必须返回一个存在的对象。
     • 引用类型作为参数:调用者必须传递一个存在的对象。

    2. 常量成员函数

     • 表示该函数只读取对象的内容,不会对对象进行修改。

    3. 返回值

     • 除开void函数,构造函数,析构函数,其它函数必须要有返回值。
     • 当函数返回引用或指针时,用文字描述其有效期。

    4. 内联函数

     • 内联函数应将函数体放到类体外。
     • 只有简单的函数才有必要设计为内联函数,复杂业务逻辑的函数不要这么做。
     • 虚函数不要设计为内联函数。

    5. 函数参数

     • 只读取该参数的内容,不对其内容做修改,用常量引用。
     • 修改参数内容,或需要通过参数返回,用非常量应用。
     • 简单数据类型用传值方式。
     • 复杂数据类型用引用或指针方式。

    八、类


    1. 构造函数

     • 构造函数的初始化列表,应和类的顺序一致。
     • 初始化列表中的每个项,应独占一行。
     • 避免出现用一个成员初始化另一个成员。
     • 构造函数应初始化所有成员,尤其是指针。
     • 不要在构造函数和析构函数中抛出异常。

    2. 纯虚函数

     • M类的虚函数应设计为纯虚函数。

    3. 构造和析构函数

     • 如果类可以继承,则应将类析构函数设计为虚函数。
     • 如果类不允许继承,则应将类析构函数设计为非虚函数。
     • 如果类不能被复制,则应将拷贝构造函数和赋值运算符设计为私有的。
     • 如果为类设计了构造函数,则应有析构函数。

    4. 成员变量

     • 尽量避免使用mutableVolatile
     • 尽量避免使用公有成员变量。

    5. 成员函数

     • 努力使类的接口少而完备。
     • 尽量使用常成员函数代替非常成员函数,const函数
     • 除非特别理由,绝不要重新定义(继承来的)非虚函数。(这样是覆盖,基类的某些属性无初始化)

    6. 继承

     • 继承必须满足IS-A的关系,HAS-A应采用包含。
     • 虚函数不要采用默认参数。
     • 除非特别需要,应避免设计大而全的虚函数,虚函数功能要单一。
     • 除非特别需要,避免将基类强制转换成派生类。

    7. 友元

     • 尽量避免使用友元函数和友元类。

    九、错误处理


    • 申请内存用new操作符。
    • 释放内存用delete操作符。
    • newdeletenew[]delete[]成对使用。
    • 申请内存完成之后,要检测指针是否申请成功,处理申请失败的情况。
    • 谁申请谁释放。优先级:函数层面,类层面,模块层面。
    • 释放内存完成后将指针赋空,避免出现野指针。
    • 使用指针前进行判断合法性,应考虑到为空的情况的处理。
    • 使用数组时,应先判断索引的有效性,处理无效的索引的情况。
    • 代码不能出现编译警告。
    • 使用错误传递的错误处理思想。
    • 卫句风格:先处理所有可能发生错误的情况,再处理正常情况。
    • 嵌套do-while(0)宏:目的是将一组语句变成一个语句,避免被其他if等中断。

    十、性能


    • 使用前向声明代替#include指令。Class M;
    • 尽量用++i代替i++。即用前缀代替后缀运算。
    • 尽量在for循环之前,先写计算估值表达式。
    • 尽量避免在循环体内部定义对象。
    • 避免对象拷贝,尤其是代价很高的对象拷贝。
    • 避免生成临时对象,尤其是大的临时对象。
    • 注意大尺寸对象数组。
    • 80-20原则。

    十一、兼容性


    • 遵守ANSI C和ISO C++国际标准。
    • 确保类型转换不会丢失信息。
    • 注意双字节字符的兼容性。
    • 注意运算溢出问题。
    • 不要假设类型的存储尺寸。
    • 不要假设表达式的运算顺序。
    • 不要假设函数参数的计算顺序。
    • 不要假设不同源文件中静态或全局变量的初始化顺序。
    • 不要依赖编译器基于实现、未明确或未定义的功能。
    • 将所有#include的文件名视为大小写敏感。
    • 避免使用全局变量、静态变量、函数静态变量、类静态变量。在使用静态库,动态库,多线程环境时,会导致兼容性问题。
    • 不要重新实现标准库函数,如STL已经存在的。

    展开全文
  • 华为C/C++编码规范

    千次下载 热门讨论 2020-07-30 23:30:34
    华为C/C++的编码规范,刚开始编程的程序员们学习一下华为的编码风格哦!
  • 编码规范——华为篇

    千次阅读 2020-06-14 11:30:52
    编码规范很重要,其实他直接影响到了代码迭代更新的效率和出问题的概率。以下为本人对网上广为流传的华为编码规范的个人总结。(ps:其中有几个原则实在是精辟的不能再精辟了,当然也有一些存在疑惑,还希望各位大佬...

    编码规范很重要,其实他直接影响到了代码迭代更新的效率和出问题的概率。以下为本人对网上广为流传的华为编码规范的个人总结。(ps:其中有几个原则实在是精辟的不能再精辟了,当然也有一些存在疑惑,还希望各位大佬不吝赐教)


    1.不要使用难懂的技巧性很高的语句,除非很有必要时

    高技巧语句不等于高效率的程序,实际上程序的效率关键在于算法。这可能是很多初学者最容易犯得错误。

    2.去掉没必要的公共变量

    公共变量是增大模块间耦合的原因之一。全局变量虽然好用,但是宜少不宜多这样能保证数据的安全性。

    3.当向公共变量传递数据时,最好做数据合法性检查。

    有必要最好做一下,因为万一出了问题是不好检测出来的。

    4.构造仅有一个模块或函数可以修改、创建,而其余有关模块或函数只访问的公共变量,
    防止多个不同模块或函数都可以修改、创建同一公共变量的现象

    还是前面讲到的数据安全性问题,可以通过静态函数实现,且整个系统都要保持一致

    5.仔细设计结构中元素的布局与排列顺序, 使结构容易理解、 节省占用空间, 并减少引起
    误用现象

    示例:如下结构中的位域排列,将占较大空间,可读性也稍差。
    typedef struct EXAMPLE_STRU
    {
    unsigned int valid: 1;
    PERSON person;
    unsigned int set_flg: 1;
    } EXAMPLE;
    若改成如下形式,不仅可节省 1 字节空间,可读性也变好了。
    typedef struct EXAMPLE_STRU
    {
    unsigned int valid: 1;
    unsigned int set_flg: 1;
    PERSON person ;
    } EXAMPLE;

    6.尽量减少没有必要的数据类型默认转换与强制转换。

    7.对所调用函数的错误返回码要仔细、全面地处理

    Linux系统里好像是不允许有空函数的

    8.防止将函数的参数作为工作变量

    将函数的参数作为工作变量, 有可能错误地改变参数内容, 所以很危险。 对必须改
    变的参数,最好先用局部变量代之,最后再将该局部变量的内容赋给该参数。

    示例:下函数的实现不太好。
    void sum_data( unsigned int num, int *data, int *sum )
    {
    unsigned int count;
    *sum = 0;
    for (count = 0; count < num; count++)
    {
    *sum += data[count]; // sum 成了工作变量,不太好。
    }
    }
    若改为如下,则更好些。
    void sum_data( unsigned int num, int *data, int *sum )
    {
    unsigned int count ;
    int sum_temp;
    sum_temp = 0;
    for (count = 0; count < num; count ++)
    {
    sum_temp += data[count];
    }
    *sum = sum_temp;
    }

    9.一个函数仅完成一件功能。

    10.避免设计多参数函数,不使用的参数从接口中去掉。

    目的减少函数间接口的复杂度,参数多的话可以通过结构体实现

    11.非调度函数应减少或防止控制参数,尽量只使用数据参数

    避免函数功能不明确,给调试带来麻烦

    示例:如下函数构造不太合理。
    int add_sub( int a, int b, unsigned char add_sub_flg )
    {
    if (add_sub_flg == INTEGER_ADD)
    {
    return (a + b);
    }
    else
    {
    return (a ٛ b);
    }
    }
    不如分为如下两个函数清晰。
    int add( int a, int b )
    {
    return (a + b);
    }
    int sub( int a, int b )
    {
    return (a ٛ b);
    }

    12.检查函数所有参数输入的有效性

    功能不明确较小的函数,特别是仅有一个上级函数调用它时, 应考虑把它合并到上级
    函数中, 而不必单独存在

    13.设计高扇入、 合理扇出(小于7) 的函数。

    函数较合理的扇出(调度函数除外) 通常是 3-5.较良好的软件结构通常是顶层函数的扇出较高, 中层函数的扇出较少, 而底层函数则扇入到公共模块中。还是强调函数的高复用性和可读性

    14.避免使用BOOL参数

    TURE/FALSE 的含义是非常模糊的,这点确实有点惊讶,对于那些内存要求不是很苛刻的能不用就不用吧

    15.对于提供了返回值的函数, 在引用时最好使用其返回值。

    16.当一个变量名较长且有较多引用时(一般是结构的成员), 可以用一个
    意义相当的宏代替

    也可以定义一个局部变量,在用之前对局部变量赋值

    17.在同一项目组或产品组内, 调测打印出的信息串的格式要有统一的形式。 信息串中至少
    要有所在模块名(或源文件名) 及行号

    行号和文件名可以用宏__LINE__和__FILE__实现

    18.使用断言来发现软件问题, 提高代码可测性。

    断言可以对在系统中隐藏很深, 用其它手段极难发现的问题进行定位

    示例:下面是 C 语言中的一个断言,用宏来设计的。(其中 NULL 为 0L)
    #ifdef _EXAM_ASSERT_TEST_ // 若使用断言测试
    void exam_assert( char * file_name, unsigned int line_no )
    {
    printf( "\n[EXAM]Assert failed: %s, line %u\n",
    file_name, line_no );
    abort( );
    }
    #define EXAM_ASSERT( condition )
    if (condition) // 若条件成立,则无动作
    NULL;
    else // 否则报告
    exam_assert( __FILE__, __LINE__ )
    #else // 若不使用断言测试
    #define EXAM_ASSERT(condition) NULL
    #endif /* end of ASSERT */

    19.在编写代码之前, 应预先设计好程序调试与测试的方法和手段, 并设计好各种调测开关
    及相应测试代码如打印函数等

    20.在保证软件系统的正确性、 稳定性、可读性及可测性的前提下, 提高代码效率。
     

    21.避免循环体内含判断语句, 应将循环语句置于判断语句的代码块之中

    笔者确实踩过这样的坑,并且真的很难发现是什么问题。另外循环嵌套尽量不要超过三层且不要太复杂。

    22.尽量用乘法或其它方法代替除法,特别是浮点运算中的除法。

    浮点运算除法要占用较多 CPU 资源。应为一般的cpu只有硬件乘法器

    23.过程/函数中申请的(为打开文件而使用的)文件句柄,在过程/函数退出之前要关闭。

    分配的内存不释放以及文件句柄不关闭, 是较常见的错误, 而且稍不注意就有可能发生。这类错误往往会引起很严重后果,且难以定位

    24.有可能的话, if语句尽量加上else分支, 对没有else分支的语句要小心对待; switch
    语句必须有default分支。

    25.时刻注意表达式是否会上溢、 下溢。

    示例:如下程序将造成变量下溢。
    unsigned char size ;
    while (size-- >= 0) // 将出现下溢
    {
    ... // program code
    }

    26.打开编译器的所有警告开关对程序进行编译

    27.某些语句经编译后产生警告,但如果你认为它是正确的,那么应通过某种手段去掉告
    警信息

    示例:
    #pragma warn -rvl // 关闭告警
    int examples_fun( void )
    {
    // 程序,但无 return 语句。
    }
    #pragma warn +rvl // 打开告警

    28.使用代码检查工具(如C语言用PC-Lint)对源程序检查。使用软件工具(如 LogiSCOPE)进行代码审查

    用过其中一个,效果不理想可能是不会用吧

    29.不应通过“试” 来解决问题,应寻找问题的根本原因

    最精辟的原则之一,可很多人就是通过“试”

    30.对自动消失的错误进行分析,搞清楚错误是如何消失的

    最精辟的原则之一,对于提高能力有很大帮助

     

    骗阅览量链接:

    编码规范——NASA篇

    展开全文
  • 编码规范

    2020-07-26 19:09:00
    编码规范 1. 代码清晰度 无规矩不成方圆,编程也是有套路的,好的代码不仅要好的性能,还要有好的规范。 如果代码没有按照一定的规范进行编写,那么代码的可维护性就会很差,相信任何人都不太愿意接手不规范的代码...

    编码规范

    1. 代码清晰度

    无规矩不成方圆,编程也是有套路的,好的代码不仅要好的性能,还要有好的规范。

    如果代码没有按照一定的规范进行编写,那么代码的可维护性就会很差,相信任何人都不太愿意接手不规范的代码。代码的清晰度是一个衡量开发人员编码素质的重要标准。

    2. PSR规范

    每一个编程语言都有自己的编码规范,PHP也不例外,PHP语言公认的编码规范就是PSR规范,PSR规范官方网址https://www.php-fig.org/psr/

    PSRPHP Standard Recommendations的简写,由PHP FIG组织制定的PHP规范,FIGFramework Interoperability Group(框架可互用性小组)的缩写,由几位开源框架的开发者成立于 2009 年,从那开始也选取了很多其他成员进来(包括但不限于Laravel, Joomla, Drupal, Composer, Phalcon, Slim, Symfony, Zend Framework等)。

    • 2.1 主要psr规范
    规范名称 内容
    psr-1 语法规范
    psr-3 日志接口规范
    psr-4 类自动加载规范
    psr-6 缓存接口规范
    psr-11 容器接口规范
    psr-16 简单缓存接口规范
    • 2.2 PSR规范术语
    术语 含义
    MUST 必须
    MUST NOT 一定不能
    REQUIRED 需要
    SHALL 将会
    SHALL NOT 不会
    SHOULD 应该
    SHOULD NOT 不应该
    RECOMMENDED 推荐
    MAY 可以
    OPTIONAL 可选的

    3. PSR-1

    PSR-1规范主要对PHP文件及语法做了规范,主要内容如下。

    • Files MUST use only <?php and <?= tags
    • Files MUST use only UTF-8 without BOM for PHP code
    • Files SHOULD either declare symbols (classes, functions, constants, etc.) or cause side-effects (e.g. generate output, change .ini settings, etc.) but SHOULD NOT do both
    • Namespaces and classes MUST follow an “autoloading” PSR: [PSR-0, PSR-4]
    • Class names MUST be declared in StudlyCaps
    • Class constants MUST be declared in all upper case with underscore separators
    • Method names MUST be declared in camelCase

    4. 符合PSR-1规范的示例类

    region注释块对Phpstorm ide友好,阅读代码的时候可以折叠,建议在实际开发中将相关联代码块整体用region注释块标注功能,便于阅读代码。

    <?php
    //文件名以<?php开始,命名空间和目录保持一致,遵从PSR-4类自动加载
    namespace app\models;
    
    
    //类名称使用大驼峰
    class UserModel
    {
        //region 1.1 常量规范
        //常量所有单词全部大写,单词间用下划线分隔
        const SOURCE_PC      = 1;
        const SOURCE_ANDROID = 2;
        const SOURCE_IOS     = 3;
        const SOURCE_WEIXIN  = 4;
        //endregion
    
        //region 1.2 属性规范
        //public属性使用小驼峰
        public $userId;
    
        //static属性规范与实例属性规范一致
        public static $sourceMap = [
            self::SOURCE_PC      => 'PC',
            self::SOURCE_ANDROID => 'ANDROID',
            self::SOURCE_IOS     => 'IOS',
            self::SOURCE_WEIXIN  => 'WEIXIN',
        ];
        
        //protected属性使用下划线开头,单词遵从小驼峰
        protected $_loginTimes = 0;
        
        //static属性规范与实例属性规范一致
        protected static $_dataPool;
        
        //private属性使用下划线开头,单词遵从小驼峰
        private $_createTime;
        
        //static属性规范与实例属性规范一致
        private static $_objectPool;
        
        //只读属性实现
        public function getCreateTime()
        {
            return $this->_createTime;
        }
        //endregion
    
        //region 1.3 方法规范
        //public方法名称使用小驼峰
        public function getInfo($id)
        {
    
        }
    
        //static方法规范与实例方法规范一致
        public static function getDb()
        {
    
        }
    
        //protected方法以下划线开头,单词遵从小驼峰
        protected function _formatInfo($info = [])
        {
    
        }
    
        //static方法规范与实例方法规范一致
        protected static function _getData($key)
        {
            
        }
    
        //private方法以下划线开头,单词遵从小驼峰
        private function _initSource()
        {
    
        }
    
        //static方法规范与实例方法规范一致
        private function _getObject($key)
        {
            
        }    
        //endregion
    }
    

    好了,看到这里你已经掌握了PSR-1规范的大部分内容了,你离大神的距离又近了一步了哦!加油!

    学习更多内容: https://404.360tryst.com

    我的视频课程: https://edu.csdn.net/course/detail/9933

    展开全文
  • PHP程序员为什么要培养自己的编码规范? 为什么我们要培养自己的编码规范?...我们写代码的时候,一个好的编码规范,对我们来说能够起到很多意向不到的效果。...编码规范包含两大块,代码规范和注释规范...
  • Java编码规范总结(腾讯+阿里)

    万次阅读 2019-05-06 20:28:03
    Java编码规范总结(参考腾讯编码规范) 一、java文件组织 文件组织规则:由于超过2000行的程序难以阅读,应该尽量避免出现超过2000行的程序。一个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个...
  • 阿里云Apsara Clouder基础技能认证:阿里巴巴编码规范(最新题库)
  • IDEA安装阿里代码规范插件

    万次阅读 多人点赞 2020-06-13 11:55:53
    要养成一个好的编码习惯从自己编码开始,对自己代码的合理化命名,编码不仅对自己有好处,而且别人也容易读懂你的代码。所以下载阿里的代码规范插件来约束自己凌乱的代码。阿里规范插件GitHub地址:...
  • 阿里巴巴编码规范(Java)满分答卷

    千次阅读 2019-02-28 17:50:43
    多选 1.如何处理单元测试产生的数据,下列哪些说法是正确的?ABC A .测试数据入库时加特殊前缀标识。 B .测试数据使用独立的测试库。 C .自动回滚单元测试产生的脏数据。... D ....多选 2.... A .......
  • 下载地址:https://download.csdn.net/download/fly_hps/11787438
  • 阿里巴巴编码规范认证

    千次阅读 2018-08-27 11:13:28
     某天在CSDN上面看了一个人的文章,说考了一个阿里巴巴编码规范认证,对自己编码规范确实有很大的提升,以及在面试的时候也是一个加分项,  然后博主也去考了一下,挺幸运的吧,考了两次,第二次过了,现在把这个...
  • idea配置阿里代码规范

    万次阅读 2019-04-16 11:19:47
    无规矩不成方圆,无规范不能协作。阿里近万名Java技术精英的经验总结,铸就了高含金量的《阿里巴巴Java开发手册》,并向业界开放,希望使团队在Java开发上更高效、容错、有协作性,提高代码质量并降低维护成本。本...
  • 获得阿里巴巴编码规范技能认证

    万次阅读 2019-12-11 16:19:49
    【前言】 通过对阿里巴巴Java开发手册的学习与总结,今天进行了阿里巴巴举办的在线认证考试,并最终通过认证。 【认证过程】 1、学习资料: ... (1)在线---阿里巴巴Java开发手册终极版v1.3.0.pdf ...
  • 新版chrome修改编码

    万次阅读 2018-04-25 22:25:37
    chrome 5.5 之后取消编码设置,采用自动识别编码,但是在部分设置不规范不正确的网站,新版浏览器无法准确判断其使用的编码,导致网站显示乱码,我们可以通过在谷歌商店安装 charset插件来实现修改编码的功能,GitHub...
  • 字符集详解(学习,看一篇就够了)

    万次阅读 多人点赞 2020-05-31 11:19:55
    本文致力于一篇文章就可以让初学者对字符集编码有一个全面的认识,为将来开发项目充实其理论基础,为解决BUG提供思路。
  • 1.4.1 Android的编码规范

    万次阅读 2016-05-16 00:15:47
    1.4.1 Android的编码规范标签: StudyNote 本文声明: 本文由Coder-pig编写,想了解其他内容,可见CoderPig’s Android Study Note——目录 尊重作者劳动成果,未经本人授权,禁止转载!违者必究! 目录源...
  • 通常,在公司中都有编码规范,然而这些编码规范执行的好与坏却很少有人关心,编码规范有两个大的方面作用:一是可以使代码容易理解,当然这也是最主要的作用;另外就是通过有效的编码规范可以提高程序的稳定性。...
  • 使用python进行URL编码

    万次阅读 2018-09-10 19:41:46
    在写网络爬虫时,发现提交表单中的中文字符都变成了TextBox1=%B8%C5%C2%CA%C2%DB这种样子,观察这是中文对应的GB2312编码,实际上是进行了GB2312编码和urlencode。 那么为什么要对URL进行encode? 因为在标准的url...
1 2 3 4 5 ... 20
收藏数 331,423
精华内容 132,569
关键字:

编码规范