代码注释中的5要与3不要技巧

代码注解,也许说是比代码自己更重大。这边有一些办法也许保证你写在代码中的注解是交情的:

不要反复浏览者曾经了解的实质

能精确解说代码是做甚么的注解对咱们是没有辅助的。

//Ifthecolorisred,turnitgreenif(color.is_red()){color.turn_green();}

要注解解说推理和史书

假若代码中的交易逻辑此后也许须要革新或改变,那就理当留住注解:)

/*TheAPIcurrentlyreturnsanarrayofitemseventhoughthatwillchangeinanup


转载请注明:http://www.aierlanlan.com/cyrz/1169.html

  • 上一篇文章:
  •   
  • 下一篇文章: 没有了