May 2025
Intermediate to advanced
124 pages
1h 7m
Chinese
本作品已使用人工智能进行翻译。欢迎您提供反馈和意见:translation-feedback@oreilly.com
你知道,当你阅读一些代码时,你会说 "哦,原来是这么回事!"。这就是一个宝贵的时刻。记录下来。
只写下代码中不明显的内容。设身处地为未来的读者或 15 分钟前的自己想想。你希望知道什么?你可能会记下这样一句话:"由于需要尽可能减少网络调用的次数,下面的内容变得复杂了"。
给特定的人写信,即使他们和你不太一样。你是计算机科学家团队中唯一的生物学家吗?那你最好解释一下代码中的生物学背景,即使这在你看来是显而易见的。关键是要站在别人的角度思考问题,并尝试先发制人地解决可能出现的问题。
如果遇到没有页眉注释的文件,可以考虑添加一个页眉,告诉潜在读者为什么阅读这个文件可能会有用。(谢谢,AllanMertner)。
发现缺陷后立即进行注释是个好时机。例如,// Be sure to change ../foo if you add another case 。在代码中出现这种耦合并不理想。最终,您必须学会如何消除耦合,但在此期间,添加注释指出耦合问题要比把它埋在沙子里要好得多。
Read now
Unlock full access