كيف يمكنك تحديد وثائق وظيفة واجهة برمجة التطبيقات (API) التي يجب قراءتها ومدى جديتها؟[مغلق]

Question

لنفترض أنك تكتب أو تحتفظ بجزء من التعليمات البرمجية التي تستخدم بعض واجهات برمجة التطبيقات (API) التي لا تعرفها بنسبة 100%.

كيف يمكنك أن تقرر ما إذا كنت تريد قراءة الوثائق الخاصة بهدف اتصال معين، وكم من الوقت ستقضيه في قراءتها؟كيف تقرر عدم قراءتها؟

(لنفترض أنه يمكنك قراءتها عن طريق فتح وثائق HTML، أو فحص الكود المصدري، أو استخدام آلية التمرير في IDE).

Answer 1

من الناحية المثالية يجب أن تقرأ الجميع منه، ولكننا نعلم أن هذا هو الألم في...أنت تعرف.ما أفعله عادةً في تلك الحالات (وقد فعلت ذلك كثيرًا أثناء عملي كمستقل) هو وزن بعض العوامل واعتمادًا على النتيجة، أقرأ المستندات.

العوامل التي تخبرني أنه لا ينبغي لي قراءة المستندات:

• من السهل تخمين ما تفعله الوظيفة من الاسم.
• إنه ليس ذا صلة بالرمز الذي أحتفظ به:على سبيل المثال، أنت تتحقق من كيفية حذف بعض التعليمات البرمجية للملفات، ولديك بعض الوظائف التي من الواضح أنها تقوم ببعض تحديثات واجهة المستخدم.أنت لا تهتم بذلك في الوقت الحالي.
• إذا التصحيح:لم تغير الوظيفة حالة البرنامج بطريقة مفيدة للمهمة المطروحة.كما كان من قبل، لا تريد معرفة ما يفعله SetOverlayIcon، إذا كنت تقوم بتصحيح أخطاء رمز الحذف لأنه يموت بسبب خطأ في نظام الملفات.
• واجهة برمجة التطبيقات (API) هي مجرد حالة خاصة لواجهة برمجة التطبيقات (API) التي تعرفها بالفعل ويمكنك تخمين ما هي الحالة الخاصة وما تفعله الوسيطات الخاصة (إن وجدت).على سبيل المثال، لنفترض أن لديك WriteToFile (اسم ملف السلسلة) وWriteToFile (اسم ملف السلسلة، الكتابة المنطقية).

وبطبيعة الحال، كل شيء يعتمد على السياق، لذلك حتى تلك القواعد لها استثناءات.