你怎么决定哪API function文件读取以及如何认真？[关闭]

Question

假设你正在编写或维持一段代码使用的一些API，你不是100%熟悉的。

你怎么决定是否阅读该文件的某些呼吁的目标，以及有多少花时间读它吗？你怎么决定不阅读它吗？

(让我们假设你可以读它通过开HTML文档、检查的源代码，或使用悬停机制在IDE)。

Answer 1

理想的情况你应该读读 所有 它，但是我们知道这是一个痛苦的...你知道的。我通常做的那些情况下(我做了很多的话，我作为一名自由职业者)是重的一些因素，并根据结果，我读的文档。

因，告诉我我不应该阅读的文档：

• 什么是功能不是很容易猜测的名称。
• 它是不相关代码我维持:例如，检查如何，有些代码删除的文件，并且你有一些功能显然不会一些UI更新。你不关心，对于现在。
• 如果调试：功能并没有改变程序状态的方式有意义的对手头的任务。和以前一样，你不想要了解什么SetOverlayIcon不，如果你正在调试删除码，因为它是死亡的文件系统的错误。
• API仅仅是一个特殊的情况下API你已经知道，你可以猜猜什么特别情况是什么，什么特别的参数(如果有的话)做。例如，我们说你有WriteToFile(string filename)和WriteToFile(string名，复盖布尔).

当然，一切都取决的上下文，因此，即使这些规则有例外。