Avatar ·

كيفية الإشارة إلى الطرق بشكل صحيح في Javadoc وما هو {@link}؟

مرحبًا بالجميع! لقد بدأت للتو في تعلم Java وأكتب توثيقًا لمشروعي. واجهت مشكلة: أريد في تعليقات Javadoc إنشاء رابط إلى طريقة أخرى لتسهيل قراءة التوثيق. على سبيل المثال، لدي كلاس `Calculator` مع طرق `add()` و `sumAndPrint()`. في الطريقة الثانية، أريد في الوصف أن أذكر أنها تستدعي `add()`. حاولت كتابة `#add` أو `{@link add}` ولكن هذا لا يعمل — لا يظهر الرابط في توثيق HTML المُنشأ. في التوثيق الرسمي مكتوب شيء عن `{@link #methodName}`، لكنني لا أفهم كيفية تحديد المسار الكامل بشكل صحيح إذا كانت الطريقة في كلاس آخر أو تحتوي على باراميترات. إليك مثال على الكود الخاص بي: ```java /** * آلة حاسبة للعمليات الحسابية البسيطة. */ public class Calculator { /** * يجمع رقمين. * @param a الرقم الأول * @param b الرقم الثاني * @return مجموع a و b */ public int add(int a, int b) { return a + b; } ```