第五章:如何编写代码注释

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/biao_java/article/details/88824464
  1. 什么是代码注释?
    1. 从语法的角度来看,注释就是编译器忽略不计的源代码块
    2. 从语义的角度来看,注释是昏暗肮脏的小路和明亮通畅的大道之间的区别
  2. 注释是用来做什么的?
    1. 注释是用来给人看的
    2. 应该集中描述为什么有些东西要怎么写,或者下一个语句块最终起到什么作用
  3. 需要多少注释?
    1. 应该只有在能为代码添加色彩的时候才编写注释
  4. 如何编写有效的注释?
    1. 尽量只写少量的好注释
    2. 编写解释为什么的注释
    3. 集中精力编写优秀的代码,而不是过多的注释
    4. 编写有意义、有帮助的注释

猜你喜欢

转载自blog.csdn.net/biao_java/article/details/88824464