من كتاب كيف تفكر كعالم كمبيوتر لغه جافا الفصل الثامن السلاسل المحرفية : قراءة الوثائق

[عماد الكامل]

قراءة الوثائق

إذا ذهبت إلى http://download.oracle.com/javase/6/...ng/String.html
ونقرت على charAt، ستحصل على التوثيق التالي (أو شيء يشبهه):
public char charAt(int index)
Returns the char value at the specified index. An index ranges from 0 to length()-1. The first char value of the sequence is at index 0, the next at index 1, and so on, as for array indexing.
Parameters: index - the index of the char value.
Returns: the char value at the specified index of this string. The first char value is at index 0.
Throws: IndexOutOfBoundsException - if the index argument is negative or not less than the length of this string.
السطر الأول هو نموذج العملية الأولي (prototype)، الذي يبين اسم العملية، نوع معاملاتها، ونوع الإرجاع.
السطر التالي يصف وظيفة العملية. السطر الذي يليه يشرح المعاملات والقيم المعادة. كانت الشروحات مطولة في هذه الحالة، لكن الواجب أن يوافق التوثيق صيغة قياسية. السطر الأخير يشرح أية استثناءات، في حال وجود بعضها، يمكن أن تطلقها هذه العملية.
قد تحتاج لبعض الوقتت حتى تعتاد على هذا النوع من الوثائق، لكنها تستحق الجهد المبذول.