فهرست مطالب:

نظرات Javadoc را کجا قرار دهم؟
نظرات Javadoc را کجا قرار دهم؟

تصویری: نظرات Javadoc را کجا قرار دهم؟

تصویری: نظرات Javadoc را کجا قرار دهم؟
تصویری: چگونه از نظرات Javadoc در برنامه جاوا برای مستندسازی استفاده کنیم؟ 2024, نوامبر
Anonim

را javadoc ابزار به شما اجازه می دهد قرار دادن شما نظرات درست در کنار کد شما، در داخل ". جاوا " فایل های منبع. وقتی از کد خود راضی هستید و نظرات ، شما به سادگی اجرا کنید javadoc دستور و سبک HTML شما مستندات به طور خودکار برای شما ایجاد می شود.

سپس، چگونه می توان نظرات را به Javadoc اضافه کرد؟

هنگام استفاده موارد زیر را در نظر داشته باشید نظر Javadoc را اضافه کنید (Alt+Shift+J): به اضافه کردن آ اظهار نظر در یک فیلد، مکان نما را روی اعلامیه فیلد قرار دهید. به اضافه کردن آ اظهار نظر در یک متد، مکان نما را در هر نقطه از متد یا روی اعلان آن قرار دهید.

استفاده از نظرات Javadoc چیست؟ جوادوک ابزاری است که با JDK همراه است و همینطور است استفاده شده برای تولید جاوا اسناد کد در قالب HTML از جاوا کد منبع، که به اسناد در قالب از پیش تعریف شده نیاز دارد. در زیر یک مثال ساده است که در آن خطوط داخل /*…. */ هستند جاوا چند خطی نظرات.

پس جاوادوک را کجا قرار دهم؟

می توانید نظرات JavaDoc را در هر یک از سه مکان مختلف در یک فایل منبع قرار دهید:

  1. بلافاصله قبل از اعلام کلاس عمومی.
  2. بلافاصله قبل از اعلام یک میدان عمومی.
  3. بلافاصله قبل از اعلام یک متد یا سازنده عمومی.

چگونه نظرات Javadoc را در Intellij بنویسم؟

3 پاسخ. با تایپ /** + و سپس فشردن Enter بالای یک امضای متد ایجاد می شود جوادوک خرد برای شما تو می توانی استفاده کنید عمل اصلاح سند اظهار نظر '. یک میانبر پیش فرض ندارد، اما می توانید میانبر Alt + Shift + J را در Keymap به آن اختصاص دهید، زیرا این میانبر برای هیچ چیز دیگری استفاده نمی شود.

توصیه شده: