هل هناك طريقة لتحديد "أنواع Javadoc" - معلمات مخصصة للأعضاء؟

Question

حالة الاستخدام التي يمكنني التفكير فيها هي ما يلي:

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

النظر في الثوابت المستخدمة لمفاتيح السمات:

/**
 * Request scope attribute key of the {@link com.acme.domain.User} object added by the {@link LoginAction}.
 */
public static final String USER_KEY = "com.acme.web.user";

يجب على كل مفتاح سمة عادةً توثيق نطاقه ، ونوع الكائن المخزن تحتها ، والذي يضعه ، ومن هو. سيتم استخدام "نوع / فئة Javadoc" على النحو التالي:

/**
 * @AttributeKey
 * @scope request
 * @type com.acme.domain.User
 * @source com.acme.web.action.LoginAction#processLogin()
 * @for HomePage.jsp
 */
public static final String USER_KEY = ...;

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

أنا إيجابي تقريبًا أن مثل هذا الشيء غير موجود لجافا ، ولكن هل سيكون جديراً بالاهتمام وما هي اللغات / أنظمة الوثائق الأخرى التي لديها مثل هذه الميزة؟

Answer 1

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