Jasin Yip

分类 Python 下的文章

关于注释的那点事儿

前言

虽然有些人会认为,最好的代码不需要注释。但是我认为这样的观点太过于偏激,规范的注释可以帮助我们理解别人或者自己以前写的代码。撰写这篇文章的原因,是我所在的公司(计蒜客)的项目里面的注释,很不规范,所以希望通过制定这样的一个规范来改善这个问题。最初发表于计蒜客的技术分享博客

单行注释和块注释的定义

首先我们来定义一下「单行注释」和「块注释」,在本文中所有说到的单行注释和块注释,都是指语法中所定义的意思,而不是语义上的「一行的注释」和「一大段的注释」。比如在 CoffeeScript 中的 # 就是单行注释,### 就是块注释。

- 阅读剩余部分 -