جعل سينس أوف أبي دوكومنتاتيون - دوميز

ذات مرة، حكم الناس على لغات البرمجة (بما في ذلك جافا) فقط من خلال ميزاتها النحوية. هل يفعل بيان إف ما تتوقع أن تفعله؟ هل البيانات سهلة الاستخدام؟ هل يتم تنفيذ الطرق بكفاءة؟

في الوقت الحاضر، الأمور مختلفة بعض الشيء. جافا لديها مجموعة كاملة من الميزات النحوية، ولكن جافا هو أكثر بكثير من مجرد مجموعة كبيرة من القواعد النحوية. جافا لديها معيار أبل واجهة برمجة رموز التجمعات - مكتبة ضخمة تتكون من أكثر من 4 000 فئة، ولكل منها وظائفها الخاصة، والقيود الخاصة بها، وقواعدها الخاصة للاستخدام الفعال.

البحث عن مصطلح

يمكنك العثور على أشياء في وثائق أبي بعدة طرق مختلفة. كل وسيلة مريحة في حالة واحدة أو أخرى. على سبيل المثال، جافا لديها طريقة اسمها النظام. خارج. println. ما يلي يصف طريقتين للبحث عن النظام. خارج. طريقة برينتلن.

استخدام الفهرس

إليك كيفية العثور على شيء، مثل النظام. خارج. برينتلن، باستخدام الفهرس:

1. زيارة المستندات. وحي. كوم / javase / 8 / مستندات / المعهد /.

2. انقر فوق الرابط إندكس أعلى الصفحة لفتح الفهرس، كما هو موضح في الشكل 1.

   

   الشكل 1: الصفحة الرئيسية لوثائق أبي.

   وهناك قائمة من الحروف بالقرب من أعلى المؤشر (انظر الشكل 2). انقر على الرابط P للانتقال إلى القسم برينتلن فيه.

   

   ">
   الشكل 2: صفحة فهرس وثائق واجهة برمجة التطبيقات.

3. في المقطع P، قم بالبحث عن برينتلن للعثور على إدخالات برينتلن.

   معظم متصفحات الويب تمكنك من البحث عن شيء مثل برينتلن في نص الصفحة. وإليك كيفية إجراء ذلك:

   1. تأكد من أن المتصفح يعرف أنك تريد البحث في الإطار الكبير الذي يستغرق معظم الصفحة (وليس في الإطارات الصغيرة على الجانب الأيمن من الصفحة). للقيام بذلك، انقر فوق الماوس داخل الإطار الكبير. (لا تنقر على رابط، وانقر على بعض المناطق البيضاء المحايدة للإطار.)

   2. افتح مربع الحوار بحث عن المتصفح. في معظم متصفحات ويندوز، يؤدي الضغط على كترل + F إلى إقران مربع الحوار بحث من الاختباء. في نظام التشغيل ماك، يؤدي النقر على الأمر + F إلى خدعة.

   3. عندما ترى مربع الحوار بحث، اكتب برينتلن في مربع النص وانقر على زر البحث أو البحث عن التالي.

4. اختر أحد إدخالات برينتلن.

   يحتوي القسم P على حمولة كبيرة من إدخالات برينتلن، كما هو مبين في الشكل 3 أدناه. تختلف الإدخالات عن بعضها البعض بطريقتين:

   • كل إدخال يقول برينتلن (إنت) أو برينتلن (سترينغ) أو برينتلن (سوموثرتيبنام). يمكن أن يختلف اسم النوع من إدخال إلى آخر.

   • كل إدخال يقول أن برينتلن هو أسلوب في فئة جافا. someStuff. someMoreStuff . يمكن أن تختلف الفئة من إدخال إلى آخر.

     

     إدخالات برينتلن في فهرس وثائق أبي. ">
     الشكل 3: بعض إدخالات برينتلن في فهرس وثائق أبي.

   عند هذه النقطة، فإنه يدفع لكزة حولها. إذا كنت تحاول طباعة شيء مثل "مرحبا العالم! "، تريد أحد إدخالات برينتلن (سلسلة). من ناحية أخرى، إذا كنت تحاول طباعة قيمة الطول أوفستريتلين، فربما تختار إدخال برينتلن (مزدوج).

   الآن، لنفترض أنك قررت على برينتلن (سلسلة). يمكنك الاختيار من بين ثلاثة إدخالات (سلسلة) برينتلن. واحد يقول انها طريقة في الطبقة جافا. الإعلام والتوعية. برينتستريم، والقادم هو طريقة في الطبقة جافا. الإعلام والتوعية. برينتوريتر، والثالث هو طريقة في الطبقة جافا. SQL. DriverManager. أي من الإدخالات الثلاثة التالية تختارها؟

   حسنا، ما تحاول حقا استدعائه هو شيء يدعى سيستيم. خارج. println. إذا كنت تذهب من خلال كامل البحث ريجمولول مع سيستيموت، ستجد أن النظام. خارج نوع برينتستريم. (انظر الشكل 4 أدناه). لذا فإن الإدخال برينتلن (سترينغ) الذي تقرر اختياره هو

   برينتلن (سترينغ) - الأسلوب في جافا جافا. الإعلام والتوعية. PrintStream.

   

   من المتغير لديه نوع برينتستريم. ">
   الشكل 4: المتغير خارج نوع برينتستريم.

5. انقر على الرابط للدخول الذي اخترته.

   عند النقر فوق الارتباط برينتلن (سلسلة)، ينقلك المتصفح إلى صفحة توضح طريقة برينتلن، كما هو موضح في الشكل 5. تخبرك الصفحة بما تقوم به برينتلن ("برينت a سترينغ أند ثين …") و يشير إلى صفحات مفيدة أخرى، مثل الصفحة التي تحتوي على وثائق السلسلة.

   

   طريقة برينتلن. ">
   الشكل 5: وصف لطريقة برينتلن.

باستخدام قائمة الفئات

إليك كيفية العثور على إدخال في واجهة برمجة التطبيقات من خلال البدء في قائمة الفئات:

1. انتقل إلى المستندات. وحي. كوم / javase / 8 / مستندات / المعهد /.

2. ابحث عن الصفحة التي توثق فئة النظام.

   أنت تبحث عن وثائق توضح النظام. خارج. println. لذلك يمكنك البحث عن النظام، والعمل طريقك إلى الخارج، ومن هناك، والعمل طريقك ل برينتلن.

   للعثور على رابط إلى النظام، ابحث في الإطار السفلي على الجانب الأيمن من الصفحة. (انظر الشكل 6). للحصول على تلميحات حول العثور على نص في الصفحة، راجع الخطوة 3 في قسم "استخدام الفهرس".

   

   فئة النظام. ">
   الشكل 6: إيجاد وصلة إلى فئة النظام.

   يؤدي النقر على رابط النظام إلى جعل المتصفح يعرض صفحة الوثائق لفئة النظام، كما هو موضح في الشكل 7.

   

   وثائق فئة النظام. ">
   الشكل 7: وثائق فئة النظام.

3. في صفحة التوثيق لفئة النظام، ابحث عن المتغير الخارجي.

   إذا كنت تستخدم مربع حوار بحث في متصفح الويب، فيجب النقر على الزر بحث عن التالي عدة مرات. (اسم شائع جدا، يبدو عدة مرات في عدة سياقات مختلفة على صفحة وثائق النظام). عندما كنت قد وجدت ما كنت تبحث عن، ترى جدول مثل واحد هو مبين في الشكل 4 أعلاه.

4. في الصف خارج الجدول، انقر فوق الارتباط برينتستريم.

   وفقا للوثائق، يشير المتغير خارج إلى كائن من نوع برينتستريم.وهذا يعني أن برينتلن هو جزء من فئة برينتستريم. ولهذا السبب، فإنك تنقر على رابط برينتستريم.

5. في صفحة وثائق برينتستريم، ابحث عن برينتلن (سلسلة).

   ترى تفسيرا مثل الموضح في الشكل 5 أعلاه.

يمكنك أن تفعل ذلك، أيضا

بعد اتباع الخطوات الواردة في هذه المقالة، قد يميل إلى القول: "صفقة كبيرة! يمكنني العثور برينتلن في وثائق أبي، ولكن أنا ربما لا يمكن العثور على أي شيء آخر. وإذا قام الأشخاص بإنشاء وثائق للأشياء التي يبرمجونها بأنفسهم، فإن وثائقهم لن تبدو مثل وثائق أبي القياسية. سأكون خور. "

الرد المناسب على مثل هذا الاعتراض هو" هراء! هراء! الهراء! ريش الحصان! "وهنا السبب:

• معظم الحيل التي تحتاجها للعثور على الأشياء في وثائق جافا القياسية موضحة في تعليمات هذه المقالة خطوة بخطوة. إذا كان يمكنك العثور على النظام. خارج. برينتلن، يمكنك أيضا العثور على جافاكس. تأرجح. جبوتون أو أي من 4، 200 برنامج في أبي جافا القياسية.

  و، كما تكتشف المزيد عن جافا والعلاقات بين الطبقات والأساليب والمتغيرات، ستشعر تعليمات هذه المقالة خطوة بخطوة أكثر طبيعية.

• أما بالنسبة لقراءة وثائق الآخرين، يمكنك خدش هذه المشكلة الحق من القائمة الخاصة بك. لم تتم كتابة مستندات أبي القياسية باليد. تم إنشاؤها تلقائيا من رمز برنامج جافا الفعلي. على سبيل المثال، رمز برينتستريم. جافا لديها بضعة أسطر التي تبدو مثل هذا:

  / ** * طباعة سلسلة ثم إنهاء الخط. * تتصرف هذه الطريقة كما لو أنها تستدعي *
  
  {@ لينك #print (سترينغ)}
  
  * ثم
  
  {@ لينك #println ()}
  
  . * *param x
  
  سترينغ
  
  ليتم طباعتها. * /
  

  لإنشاء وثائق أبي، ركض نقباء جافا برنامج يسمى جافادوك . استغرق برنامج جافادوك خطوط مثل هذه الحق من برينتستريم. جافا، واستخدمت الخطوط لجعل الوثائق التي تراها في متصفح الويب الخاص بك.

  المبرمجين جافا أخرى تفعل الشيء نفسه. في الواقع، كل من يكتب رمز جافا يستخدم برنامج جافادوك لتوليد الوثائق. لذا، فإن وثائق جافا الخاصة بالجميع تبدو مثل وثائق جافا الخاصة بالجميع. عندما تعرف كيفية قراءة وثائق أبي القياسية، أنت تعرف كيفية قراءة مستندات جافا الخاصة بأحد.

  ونعم، يمكنك استخدام برنامج جافادوك لإنشاء الوثائق الخاصة بك. عند تحميل جدك، يمكنك الحصول على برنامج جافادوك كجزء من الصفقة.