zoukankan      html  css  js  c++  java
  • 团队编程项目作业2-团队编程项目代码设计规范

    代码设计规范

    其中有一些强制性的重要的原则:首先就是字符串的拼加操作,必须使用StringBuilder,其次就是关于try…catch的一些用法

    1.基本原则  

         1.对于捕获后,不知道干什么事情或者也不知道怎样处理的情况,就不要捕获异常,留给外出层去捕获处理;
         2.返回类型为集合的,在方法声明中必须使用泛型,必须在javadoc中注明什么情况下返回null,什么情况下返回空集合。
         3.对于方法、变量声明范围要采用如下优先级:private、protected、public,对于变量要采用如下的优先级:局部变量、实例变量、类变量,如果必须要采用实例变量或类变量的情况下,要保证线程安全性,如有可能尽量采用ThreadLocal保存实例变量或类变量;
         4.如果不是必须,不要在循环中去定义变量或者new 对象;尽量在需要的最后一刻才去new 对象;
         5.如果不是必须,不要在循环中去用try…catch;
         6.类中对于比较复杂的逻辑要采用行注释的方式进行注释,java代码中绝对不允许采用块注释(/**/)进行注释;
         7.Java类的名称第一个子母必须大写,有多个单词组成的,每个单词的首字母大写
         8.jsp的文件名必须全部小写;
         9.Spring的bean配置文件名必须小写,格式为xxx.bean.xml,xxx.bean.xml配置文件中的<bean id=”” ,此处的id,就是将类名的第一个字母小写放到此处。

    2.类编写规范

       类的结构组织,一般按照如下的顺序:
         1.常量声明
         2.静态变量声明
         3.成员变量声明
         4.构造函数部分
         5.Finalize部分
         6.成员方法部分
         7.静态方法部分

    3.方法编写规范

        1.对成员方法,不要轻易的采用public的成员变量。主要的修饰符有public, private, protected, 无
        2.空方法中方法声明和函数体可都在一行。如: void func(){}
        3.方法和方法之间空一行
        4.方法的文档注释放在方法的紧前面,不能空一行。
        5.避免过多的参数列表,尽量控制在5个以内,若需要传递多个参数时,当使用一个容纳这些参数的对象进行传递,以提高程序的可读性和可扩展性
        6.方法中的循环潜套不能超过2层
        7.对于设计期间不需要子类来重载的类,尽量使用final
        8.每个方法尽量代码行数尽量不要超过100行(有效代码行,不包括注释),但必须保证逻辑的完整性
        9.接口中的方法默认级别为protected,只有很确认其它子系统的包会调用自己子系统的接口中的方法时,才将方法暴露为public.

  • 相关阅读:
    【TouchGFX】使用CubeMX创建touchgfx项目 -- 初始篇
    opencv haarcascades 下载
    更换 Anaconda 源(贼快)
    yii2 允许跨域
    sublime text 3 安装 pyv8 失败的解决办法
    win10 anaconda cuda11.1 安装 tensorlfow-gpu 环境
    nginx 403转404
    python requests 全部异常
    win10 anaconda 安装 tensorflow-gpu 及 jupyter notebook
    【PHP】自有图片服务器,图片动态裁剪缩放
  • 原文地址:https://www.cnblogs.com/chenggf/p/7565173.html
Copyright © 2011-2022 走看看