Skip to Content
先整理?
book

先整理?

by Kent Beck
May 2025
Intermediate to advanced
124 pages
1h 7m
Chinese
O'Reilly Media, Inc.
Content preview from 先整理?

第 14 章 注释 解释评论

本作品已使用人工智能进行翻译。欢迎您提供反馈和意见:translation-feedback@oreilly.com

你知道,当你阅读一些代码时,你会说 "哦,原来是这么回事!"。这就是一个宝贵的时刻。记录下来。

只写下代码中不明显的内容。设身处地为未来的读者或 15 分钟前的自己想想。你希望知道什么?你可能会记下这样一句话:"由于需要尽可能减少网络调用的次数,下面的内容变得复杂了"。

给特定的人写信,即使他们和你不太一样。你是计算机科学家团队中唯一的生物学家吗?那你最好解释一下代码中的生物学背景,即使这在你看来是显而易见的。关键是要站在别人的角度思考问题,并尝试先发制人地解决可能出现的问题。

如果遇到没有页眉注释的文件,可以考虑添加一个页眉,告诉潜在读者为什么阅读这个文件可能会有用。(谢谢,AllanMertner)。

发现缺陷后立即进行注释是个好时机。例如,// Be sure to change ../foo if you add another case 。在代码中出现这种耦合并不理想。最终,您必须学会如何消除耦合,但在此期间,添加注释指出耦合问题要比把它埋在沙子里要好得多。

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

超越Vibe编程

超越Vibe编程

Addy Osmani
Go程序设计语言

Go程序设计语言

艾伦A. A.多诺万, 布莱恩W. 柯尼汉

Publisher Resources

ISBN: 9798341656949