软件设计的哲学:第二十章 为什么要写注释

本文探讨了软件设计中注释的必要性,反驳了一些常见的不写注释的借口,如好代码自解释、时间紧迫、注释过时等。强调了注释在隐藏复杂性、提供设计信息和提高代码可维护性方面的作用。良好的注释能够显著提升软件质量,编写注释不仅是必要的,而且可以是有趣和有益的。

代码内文档在软件设计中起着至关重要的作用。 注释对于帮助开发人员理解系统和有效地工作是必不可少的,但是注释的作用远远不止于此。文档在抽象中也扮演着重要的角色;没有注释,就无法隐藏复杂性。最后,编写注释的过程如果处理正确,实际上将改进系统的设计。相反,如果没有良好的文档记录,好的软件设计就会失去很多价值。

不幸的是,这一观点并没有得到普遍认同。相当一部分产品代码基本上不

评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值