- . -

  之前一直没把注释当回事，代码写的比较随意，主要精力都集中在实现方面，这种状态一直持续到2014年下半年。那段时间参与了一个日企的医疗项目。他们项目运作非常严谨，在核验和指标方面做的比较多。其中有一个指标让我印象非常深刻，就是代码的注释不得少于实际有效代码的三分之一。当时，还是比较诧异的，不是很认可这个事情，但随着项目的深入，越来越感觉到这个注释的重要性了。
      首先，项目的可维护性。研发岗位更迭，项目转手。能否快速切入项目，健全的注释信息是一个很重要的因素。
      其次，便于协同开发。交叉业务在做并轨的时候，完整的注释信息非常有必要。
      最后，少给自己挖坑。
     
      附件为eclipse的注释模板，模板是xml格式的配置文件。内部字段进行一下修改，导入到eclipse里面，然后进行相关配置。这样，在生成文件和方法的时候，就会自动插入注释。根据实际情况，添加删除模板配置。
     
      设置方式：（Window ->Preference -> Java -> Code Style -> Code Template）
      自动插入设置：在Code Template设置页面的底部有一个auto的单选按钮，选中。

- . -

  之前一直没把注释当回事，代码写的比较随意，主要精力都集中在实现方面，这种状态一直持续到2014年下半年。那段时间参与了一个日企的医疗项目。他们项目运作非常严谨，在核验和指标方面做的比较多。其中有一个指标让我印象非常深刻，就是代码的注释不得少于实际有效代码的三分之一。当时，还是比较诧异的，不是很认可这个事情，但随着项目的深入，越来越感觉到这个注释的重要性了。
      首先，项目的可维护性。研发岗位更迭，项目转手。能否快速切入项目，健全的注释信息是一个很重要的因素。
      其次，便于协同开发。交叉业务在做并轨的时候，完整的注释信息非常有必要。
      最后，少给自己挖坑。
     
      附件为eclipse的注释模板，模板是xml格式的配置文件。内部字段进行一下修改，导入到eclipse里面，然后进行相关配置。这样，在生成文件和方法的时候，就会自动插入注释。根据实际情况，添加删除模板配置。
     
      设置方式：（Window ->Preference -> Java -> Code Style -> Code Template）
      自动插入设置：在Code Template设置页面的底部有一个auto的单选按钮，选中。