我赞同Martin Folwer在《重构》一书中有关代码注释的观点,并在此基础上引申一步,即好的代码注释应该“只”用来描述“为什么(Why)”会有相应的这段代码和您暂时没有搞清楚的事情,而不要包含这段代码“做了什么(What)”和“如何做的(How)”,因为如果您能做到每个方法不超过5行,那么What应该由方法名和类名来定义,而How应该由上述不超过5行的代码来定义。
我赞同Martin Folwer在《重构》一书中有关代码注释的观点,并在此基础上引申一步
最新推荐文章于 2021-07-01 19:54:56 发布