注释是一个程序员必须要具有的良好编程习惯。将自己的思想通过注释先整理出来,再用代码去体现。

比较好的写注释方式:先写出大部分注释,再开始写算法代码如果你采用的就是这种方式,那么恭喜你,你已经学会了,可以完全不看这篇文章,因为下面都是陈述这种方式能带来的好处以及用其他方式的缺点,如果你采用的不是这种注释方式,那么建议你浏览一下这篇文章,说不定会提升你的编码效率

  一般在看到算法题都会先在脑子中想出一个大概的思路,而注释就是记录这个思路的大概内容,注释可以帮我们进一步理清思路,可以使我们的代码更加模块化,每一步的代码功能更加明显。注释最主要的功能还是给自己提示,因为我们在实现上一个部分的时候,很有可能已经忘记了整个题目的大体思路,或者说忘记了下一个怎么写,这时候看到注释,立刻就能立刻想起来应该做什么,而不用浪费时间去回忆思路或者浪费时间去重新想思路,而且常常是两次想出的思路有一点点不一样,而采用哪种的选择过程同样会浪费大量时间,所以不要认为正式写代码前写注释是浪费时间,恰恰相反,这是在帮我们节省时间,而且使我们的代码思路清晰,模块划分明确。

  很多人包括我自己在学算法前期可能都喜欢写一两行注释然后开始写对应的代码或者写完了代码后加一两行注释,这两种方式都存在我上面说的忘记思路和思路不一致以及模块划分不清晰的问题,而且这两种方式写出的注释很可能会包含大量算法细节,不如上面说的方式写出的注释精炼简洁,写这些细节以及想这些细节都会浪费大量的时间,算法比赛或者笔试机试都时间有限,能省一点是一点。如果我们真是有时间富裕,我们把这个时间节省下来用来优化代码效率它不香吗。