我在代码规范踩的坑

注释

  • 最大的坑：前期没有写注释，后面得一个一个的补回来
  • 类注释：注释作者、注释类功能
  • 方法注释：说明、参数（变量名、解释）、返回值
  • 字段注释：不能尾行注释，数据对象字段不能加默认值
  • 多余的代码注释未删掉，这个需要删掉
  • 临时注释代码（可能会取消注释继续使用）使用三斜杠注释
  • 所有的接口必须注释

代码规范

  • 方法首字母必须小写。
    • 之前写统一异常拦截的时候为了图方便，直接使用了异常类名来做方法名
  • service/dao层方法命名必须规范（get/list/save/insert/remove/delete/update）
  • 数据对象、实体类起名规范（数据对象DO，数据传输对象DTO，展示对象VO）
  • 变量名取名必须能够看出有效含义（见其名知其意）
未完待续。。。。

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

社会主义核心价值观 <br> 富强、民主、文明、和谐<br> 自由、平等、公正、法治<br> 爱国、敬业、诚信、友善 <br> <br> 拥抱中国共产党 <br> 争当热爱祖国、理想远大的好少年；<br> 争当勤奋学习、追求上进的好少年；<br> 争当品德优良、团结友爱的好少年；<br> 争当体魄强健、活泼开朗的好少年。