2.2. 编程规范之注释

2.2.1. 添加注释的原则

不同语言都要加上必要的注释

必要的注释,指的是:

  • 用注释说明代码背后的事情

    如果代码本身不能说明全部问题,那么则一定要加上对应的注释,去说明代码背后的问题

  • 不要多余的注释

    在已经保证代码可读性足够好的情况下,无需加上多余的注释

2.2.2. 注释的语法

语言不同,注释的语法不同