《每天一点Java知识》Java基础知识——注释

注释原则

  • 形式统一
  • 内容准确简介(10个字)

注释语法

  • 单行注释//
  • 块注释/**/

注释分类

  • 类注释
    1. 类的维护人
    2. 类的作用
  • 方法注释
    1. 黑盒注释,输入输出,作用。
  • 变量注释
    1. 尽量不要使用注释,用命名来表达清楚含义
  • 条件语句注释
    1. 给出每段条件的判断注释
  • 循环语句注释
    1. 给出循环条件的注释
  • 算法注释
    1. 给出具体算法的注释。
  • 接口注释
    1. 给出接口的具体用处
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。