发表于: 2017-05-31 22:18:14

3 1087


一、今天完成的事情:

今天看了命名规范和交接事宜,话说我的复盘到底是做啥啊- -

1、命名规范

      包名小写

      按模块划分

      类名 ,首字母大写,使用驼峰法

      方法名使用驼峰法

2、注释规范

     类注解

        包括类创建日期,创建人,功能说明

     属性注解

        说明属性的作用,如果是参数说明有哪些参数,分别对应什么

     方法注解

         包括添加日期,添加人,功能说明

      说明性注解   

          主要是方法中对于逻辑的说明,核心功能一定要做说明

3、日志规范

      方法中如有参数,首先输出参数

      重要功能执行前后加明确的日志说明

      加日志不要引入异常

4、SVN提交规范

     提交时,除了写备注,还需要添加对应禅道的编号,如下:

     如果是修改的BUG,则需要在提交备注中写:  bug#111 ,其中111为bug在禅道中的id。

     如果是完成的任务,则需要在提交备注中写:  task#111 ,其中111为任务在禅道中的id。

     如果是完成的产品,则需要在提交备注中写:  story#111 ,其中111为产品在禅道中的id。

     注意,如果是多个bug,则需要使用“,”分割,如: bug#111,bug#112

 

 

一、代码规范

一 项目命名约定

1 GroupID 

所有项目:qding-community,若未设置,则默认继承自父项目

2 Artifact Id

根项目:wx-community

父项目:以根项目Artifact Id后缀(最后一个单词)作为本项目Artifact Id前缀(第一个单词),如:community-app、community-common、community-framework

子项目:以父项目Artifact Id后缀(最后一个单词)作为本项目Artifact Id前缀(第一个单词),中间单词则与业务相关,后缀(最后一个单词)则根据项目类型确定,如:app-goods-core、common-dao-core、framework-user-core,具体项目类型规则参见[3 项目名称]

3 项目名称

项目名称与Artifact Id规则一致,只是项目名称后缀会按项目类型命名:

       Jar:lib

       Web: web

       RMI Service:service

       RMI Client:client

       接口:core

       共用包:common

这些都是wiki上面的东西。

看了老大以前对任务流程过一遍的视屏- -

现在感觉懂了很多

二、遇到的问题:无

三、明天计划的事情:

四、收获:好好学习天天向上!


返回列表 返回列表
评论

    分享到