zoukankan      html  css  js  c++  java
  • SVN代码提交注释规范

    SVN代码提交注释规范

    为了规范代码提交过程,也为了更准确的定位问题所在,现将SVN代码提交的注释内容进行规范,目的是为了让每个人提交代码都更清晰,更友好,更易阅读。

    规范如下:

    每次提交代码必须填写代码注释
    为了更清晰的定位,注释使用三段式结构。
              第一部分,标注提交代码类型:是BUG,还是任务,还是其他需要紧急 处理的事项。

              第二部分,标注禅道上,产生该BUG或任务的编码。

             第三部分,标注完成的这个BUG或是任务的名称

    具体举例为:

    BUG:2615: 打印数据

    代码注释的作用是为了更准确定位问题所在,为了更快速的解决问题所 在,如果名称不能更准确的表明代码,或问题所在,或为了更准确的定位更 新代码的问题所在,可以在注释后部追加更准确的描述信息。
    在代码提交过程中,实际情况如果没有任务或BUG编码,代码提交时, 需要咨询相应的任务产生人员,寻求更准确的任务来源,或是派生出新的编 码。
    如果是解决问题中,发现的新问题或者是新需求提交代码时,需要在后 部标注产生需求的任务或变更的来源人员名称。
    举例如:

    BUG:2615: 打印数据 :名字

    一份耕耘,一份收获,付出就有回报永不遭遇过失败,因我所碰到的都是暂时的挫折
  • 相关阅读:
    Node Js
    动态遍历接收的参数
    负载均衡和springcloud.Ribbon
    Spring Cloud
    springboot整合hibernate
    python模块知识总结
    什么是netty--通俗易懂
    IDEA 的操作与使用
    spring 整合guava
    log4j向指定文件输出日志
  • 原文地址:https://www.cnblogs.com/raincedar/p/14931808.html
Copyright © 2011-2022 走看看