どのAPI関数ドキュメントを読むべきか、どの程度真剣に判断しますか？ [閉まっている]

Question

100％馴染みのないAPIを使用するコードを記述または保守しているとします。

特定のコールターゲットのドキュメントを読むかどうか、およびそれを読む時間をどのように決定しますか？どうやってそれを読まないと決めましたか？

（HTMLドキュメントを開く、ソースコードを調べる、またはIDEでホバーメカニズムを使用することで読むことができると仮定します）。

Answer 1

理想的には、それらのすべてを読む必要がありますが、私たちはそれが...あなたが知っている痛みであることを知っています。これらのケースで私が通常行うことは（そしてフリーランサーとして働いていた間にそれを何度もしました）、いくつかの要因を重視し、結果に応じてドキュメントを読みます。

ドキュメントを読むべきではないことを教えてくれる要素：

• 関数が行うことは、名前から簡単に推測できます。
• これは、私が管理しているコードとは関係ありません。たとえば、あるコードがどのようにファイルを削除するかを確認しており、明らかに何らかのUI更新を行う機能があります。今のところそれについては気にしません。
• デバッグの場合：関数は、現在のタスクにとって意味のある方法でプログラムの状態を変更しませんでした。以前と同様に、ファイルシステムエラーで死にかけているため、削除コードをデバッグしている場合は、SetOverlayIconの機能を学習する必要はありません。
• APIは、あなたが既に知っているAPIの特別な場合にすぎず、特別な場合とは何か、特別な引数（ある場合）は何をするかを推測できます。たとえば、WriteToFile（string filename）およびWriteToFile（string filename、boolean overwrite）があるとします。

もちろん、すべてはコンテキストに依存するため、これらのルールにも例外があります。