原文:软件设计的哲学:第十三章 注释应该描述代码中隐藏的内容

目录 . 选择约定 . 不要重复代码 . 低级注释增加了精确性 . 更高层次的注释增强直觉 . 接口文档 . 建议:什么和为什么,而不是如何 . 跨模块设计决策 . 结论 . 对第 . 节问题的回答 编写注释的原因是,在编写代码时,编程语言中的语句无法捕获开发人员头脑中的所有重要信息。注释记录了这些信息,以便以后的开发人员能够很容易地理解和修改代码。注释的指导原则是注释应该描述代码中不明显的内容 ...

2019-12-24 09:50 0 854 推荐指数:

查看详情

软件设计哲学: 第十五章 先写注释

目录 15.1 延迟的注释是糟糕的注释 15.2 先写注释 15.3 注释是一个设计工具 15.4 早期的注释很有趣 15.5 早期的注释代价高昂吗? 15.6 结论 许多开发人员将编写文档的工作推迟到开发过程的末尾,即编码和单元测试完成之后 ...

Thu Dec 26 18:04:00 CST 2019 1 679
软件设计哲学:第二十章 为什么要写注释

目录 12.1 好代码是自我解释的 12.2 我没有时间写注释 12.3 注释会过时并产生误导 12.4 我所看到的一切注释都是毫无价值的 12.5 良好的注释的好处 代码内文档在软件设计起着至关重要的作用。 注释对于帮助开发人员理解系统和有效地 ...

Mon Dec 23 21:40:00 CST 2019 0 923
软件设计哲学 第五章 隐藏信息

目录 5.1 信息隐藏 5.2 信息泄漏 5.3 时间分解 5.4示例:HTTP服务器 5.5 示例:类太多 5.6 示例:HTTP参数处理 5.7 示例:HTTP响应的默认值 5.8 隐藏在类的信息 5.9 不要过度隐藏 5.10 ...

Wed Dec 18 03:39:00 CST 2019 0 886
软件设计哲学:前言

。所有这些讨论都是有价值的,但是软件设计的核心问题在很大程度上仍然没有触及。David Parnas的经典 ...

Mon Dec 16 22:37:00 CST 2019 1 1396
软件设计哲学:第十八章 代码的可见性

目录 18.1 使代码更简单的东西 18.2 使代码不那么明显的事情 18.3 结论 晦涩是2.3节描述的复杂性的两个主要原因之一。当系统的重要信息对新开发人员来说不明显时,就会出现模糊现象。模糊问题的解决方案是用一种简单易解的方式来写代码。本章讨论 ...

Mon Dec 30 19:47:00 CST 2019 0 751
软件设计哲学:第十六章 修改现有代码

目录 16.1 保持战略 16.2 维护注释:将注释放在代码附近 16.3 注释属于代码,而不是提交日志 16.4 保留注释:避免重复 16.5 维护注释:检查差异 16.6 更高级别的注释更容易维护 第1章描述软件开发是如何迭代和增量 ...

Fri Dec 27 21:40:00 CST 2019 0 726
软件设计哲学:第三章 编程的战术和战略

“ 作者简介: 常柱,微信公众号【架构未来】作者,十多年一线互联网研发从业经验;前五八同城商业会员技术负责人,宝驾租车技术总监,现58 到家业务台技术负责人。 好的软件设计最重要的元素之一是在处理编程任务时采用的思维方式。许多组织鼓励一种战术心态,专注 ...

Mon Dec 16 23:09:00 CST 2019 0 1104
软件设计哲学【翻译】--目录

2020年必读书籍推荐:软件设计哲学(A Philosophy of Software Design),本书190多页,豆瓣的点评分在9分以上,目前只有英文版本,中文版还未上市,英文好的同学建议去直接阅读原版。 作者简介 John Ousterhout是斯坦福大学计算机科学教授。他目前 ...

Thu Dec 19 02:47:00 CST 2019 0 2411
 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM