命名

普通变量

int contentType
double flow_velocity
static int CONTENT
boolean emptyFlag

• 尽量都小写，首字母小写
• 对于静态变量，尽量采用全大写，多使用下划线进行区分
• 单词之间使用大小写（先小写再大写）隔开，或者使用下划线（_）隔开
• isEmpty，这种格式一律避免使用。改为emptyFlag

方法、函数、类

//类
public Class AdjacencyGraph{}
//方法
public static boolean RelationCal(){}

首字母大写

注释

• 将/**/调整为棕色
  主要填写编程整体思路以及注意事项
  
• 将 // 调整为绿色
  主要填写当前语句的含义、当下需要注意什么
  

Entity（实体类）

• 1、编码模型，只管标准输入输出，不操作数据库
  输入参数用xxxInput表示，输出结果用xxxOutput表示
  ThicknesssInput ThicknessOutput
• 2、需要操作数据库，即需要有一个专门用于对接数据库的实体类
  输入参数和对接数据库操作用xxxEntity，输出结果用xxxOutput表示
  ThicknessEntity ThicknessOutput
  注：由于Entity包含的字段非常多，在写文档的时候要特别写清楚输入参数是哪些

Util（工具类）

只要不在主体业务内的处理类，都统一放在Util下面
一般来说包括：
LocalDateTime与String的格式转换处理类
全局变量存放类
JSON字符串解析工具
Excel处理工具
进程相关配置

本文来自互联网用户投稿，文章观点仅代表作者本人，不代表本站立场，不承担相关法律责任。如若转载，请注明出处。 如若内容造成侵权/违法违规/事实不符，请点击【内容举报】进行投诉反馈！