
课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认真做教育 专心促就业
注释是程序员在写代码的时候都会用到的一个编程技术,而本文我们就通过案例分享来了解一下,程序员写代码注释都需要注意哪些问题。
好的注释才有价值
该不该注释是个需要认真对待的问题。差劲的注释只会浪费时间。好的注释才有价值。注释的位置可以在:变量特定的含义和限制、某个职责代码块的开始、一般控制结构的开始、子程序调用处、方法开始处描述功能、类开始处描述功能。
源代码应当含有程序大部分的关键信息。
只要程序依然在用,源代码比其他资料都能保持更新,故而将重要信息融入代码是很有好处的。
好代码本身就是好的说明
如果代码太糟,需要大量注释,应先试着改进代码,直至无须过多注释为止。
注释应说出代码无法说出的东西
例如概述或用意等信息。注释本身应该包含的是对代码的简洁的抽象概括,而不是具体代码的实现细节。
注释风格也应该简洁易于维护
有的注释风格需要许多重复性劳动,应舍弃之,改用易于维护的注释风格。
【免责声明】本文系本网编辑部分转载,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责。如涉及作品内容、版权和其它问题,请在30日内与管理员联系,我们会予以更改或删除相关文章,以保证您的权益!更多内容请加danei0707学习了解。欢迎关注“达内在线”参与分销,赚更多好礼。