如果只讨论函数内部的注释，先搞清楚代码会给谁看：

*以下前提是有良好命名规则和不太高的代码复杂度*

先把代码的排版弄好：大括号换行不换行统一，等号参数对齐，缩进都整理好，代码间加入合适的空行，变量声明位置和顺序什么的

如果是给领导开会讲读，注释把执行顺序和逻辑介绍清楚。

如果是给同组同事或者自己看，那么一些经常被问、奇怪反直觉的点写清楚就行。

如果是写给其他同事，或者是当作库类放出去，函数内部注释就不是特别要紧，不过着重弄清楚错误 /异常处理相关是不会错。看库代码很多都是为了搞清楚 edge cases 。

如果是写给新手，那么基本上就要每行都注释。

如果是算法的代码，告诉是什么算法和有什么效果即可，网上有很多能很好解释算法的文章。

代码写得差应该是学习怎么写代码，而不是说注释写清楚就行；注释能方便理解屎山，但是屎山不会因为好的注释变成好代码。