2024年4月15日发(作者：)
注释设计怎么写
我认为注释最终作用无非就两个。
1.和伪代码一样的作用，为接下来要实现的功能写出一个指导性的算法思路。只是没
有伪代码详细。但是也指出了完成此功能的大体算法思路。
2.给看代码的人一个解释性说明。注意看代码的人包括你自己。让看你代码的人可以
快速的浏览你的代 码，而不至于每看一行都要一层 一层的方法看下去，才能了解你这个
方法到底在干什么。
简单的说注释作用就是:写的时候提供算法思路。读的时候能快速了解你大约是怎么完
成这个功能。
很多公司或者个人希望开发者注释写的足够详细。以为这样就可以提高可读性。我觉
得这个想法是有问题的。
1.首先开发者写注释的时间可能超过了写代码。如果把大把的时间浪费在写注释上了，
那么开发者还怎么能设计出足够好的代码呢。
2.看注释的人不得不一边看注释，一边看代码。我觉得没有哪个程序员会在看了足够
详细的注释的时候就真的相信了注释而不看 具体的代码了。或者看完代码之后不看下注
释确认下自己的理解对不对。那么就会造成老师期末考试的时候划重点的时候说每章 的
都 是重点。
下面是我个人对注释写法的一些见解。
1.其实很简陋啊。就是你实现的时候的伪代码的超级精简版。你要完成一个功能你就
是 1.先xxx 2.在xxx 3.在xxx。那就把这个 1,2,3 注释写 上去就好了。如果有其他很重
要的步骤的话，也可以写下注释说明。但是主流程 1,2,3必须要清楚。
举个例子:
->coding。
一个人早上上班的流程。起床->刷牙->吃早饭->坐公交->刷卡->早会
发布者：admin，转转请注明出处：http://www.yc00.com/news/1713128302a2188445.html
评论列表（0条）