param
يمكن لعلامة param أرشفة معلمة واحدة من طريقة أو مُنشئ ، أو اكتب معلمات فئة الأرشيف والواجهة والطرق العامة. عند استخدام علامة param ، يجب أن نستخدم إحدى العلامات لكل معلمة من الطريقة. سيتم اعتبار الكلمة الأولى في كل فقرة اسمًا للمعلمة ، بينما سيتم اعتبار الباقي وصفًا لها:
Param Max الحد الأقصى لعدد الكلمات للقراءة.
عند معلمات نوع الأرشفة ، يجب أن نضيف <و> إلى كلا الجانبين من اسم المعلمة النوع:
param 体中国中国中国中国
ومع ذلك ، عادة ما لا تتطلب معلمات النوع وثائق صريحة ، لأنها جميعها واضحة للغاية.
@ يرى
يمكن أن تنشئ علامات see مراجع متقاطعة مرتبطة بمستندات Javadoc الأخرى. يمكننا تسمية أي معرفات بعد العلامة ، على الرغم من أننا يجب أن نؤهلها بالكامل. على سبيل المثال ، يمكن عادة تسميته باسم عضو بسيط لعضو في الفصل ، ولكن إذا كان العضو طريقة محملة ، فيجب علينا تحديد الإصدار الزائد للطريقة من خلال تعداد أنواع كل معلمة. يمكننا استخدام اسم غير مؤهل لتحديد الواجهة أو الفئة داخل الحزمة الحالية ، ولكن يجب علينا استخدام اسم مؤهل تمامًا لتحديد الأنواع في الحزم الأخرى. يمكننا تحديد أعضاء النوع باستخدام # قبل اسم العضو. فيما يلي كل شيء صالح @ انظر تنسيقات العلامات:
see #getnameseesee attresese com.magic.attrttrsese com.magic.attr.deck#deck-sizesese com.magic.attr.attr#getNamese com.magic.attr.attr com.magic.attr.attr#attr (string ، Object) seese com.magic.attr sele specification @seee "The Java Developer's Almanac"
يشير النموذج الأول إلى طريقة تسمى GetName ، والتي تقع في نفس الفئة أو واجهة مع مراقبة المستند نفسه ، أو في فئة محيطة معينة أو واجهة محيطة. يمكن أيضًا تطبيق بناء الجملة على البنائين والحقول. يشير النموذج الثاني إلى الفصل في الحزمة الحالية أو الفصل في حزمة دليل معينة. يشير النموذج الثالث إلى فصل باستخدام اسم مؤهل تمامًا.
تشير الأشكال الأربعة الأخيرة من see @إلى الأعضاء ، حيث يدوران الأولان حول المجالات (يوم deck-siz والطريقة (getName). يمكننا استخدام اسم الطريقة مباشرة لأنه يتم تعريف طريقة getName واحدة فقط في فئة ATTR. التي نريد الإشارة إليها.
يقود نموذج SEE التالي القارئ إلى حزمة محددة: com.magic.attro
يسمح لنا النموذجان الأخيرين بالاستشهاد بمستندات أخرى. من بينها ، يستخدمه السابق لتحديد الرابط ، ويستخدم الأخير عروض الأسعار لإحاطة اسم المستند. يمكننا استخدام كلا النموذجين لتوجيه القارئ إلى مستندات أخرى ، مثل الدليل الكامل.
نموذج seee (جميع النماذج باستثناء النموذجين الأخيرين أعلاه) التي تسمي كيان اللغة يمكن أن يتبعها تسمية. في المستند الذي تم إنشاؤه ، سيحل اسم التسمية هذا محل اسم الكيان. على سبيل المثال:
@ انظر أسماء #GetNameAttribute
سيتم إنشاء رابط لمستند GetName ، ولكن النص الذي يعرضه هو "أسماء السمات" بدلاً من "getName". عادةً ما نستخدم الأسماء الحقيقية للأعضاء ، ولكن الميزات الموضحة هنا مفيدة أحيانًا.