| JAVADOC(1) | JDK Commands | JAVADOC(1) |
نام (NAME)
javadoc - تولید صفحات HTML مستندات API از فایل‌های منبع جاوا
خلاصه دستور (SYNOPSIS)
javadoc [options] [packagenames] [sourcefiles] [@files]
- options
- گزینه‌های خط فرمان را مشخص می‌کند که با فاصله از هم جدا می‌شوند. بخش‌های گزینه‌های JAVADOC، گزینه‌های گسترش‌یافته، گزینه‌های داکلت استاندارد، و گزینه‌های اضافی ارائه‌شده توسط داکلت استاندارد را ببینید.
- packagenames
- نام بسته‌هایی را که می‌خواهید مستندسازی کنید مشخص می‌کند که با فاصله از هم جدا شده‌اند، برای مثال java.lang java.lang.reflect java.awt. اگر می‌خواهید زیربسته‌ها را نیز مستندسازی کنید، از گزینه -subpackages برای مشخص کردن بسته‌ها استفاده کنید.
به‌طور پیش‌فرض، javadoc به دنبال بسته‌های مشخص‌شده در دایرکتوری جاری و زیردایرکتوری‌های آن می‌گردد. از گزینه -sourcepath برای مشخص کردن فهرست دایرکتوری‌های محل جستجوی بسته‌ها استفاده کنید.
- sourcefiles
- نام فایل‌های منبع جاوا را که می‌خواهید مستندسازی کنید مشخص می‌کند که با فاصله از هم جدا شده‌اند، برای مثال Class.java Object.java Button.java. به‌طور پیش‌فرض، javadoc به دنبال کلاس‌های مشخص‌شده در دایرکتوری جاری می‌گردد. با این حال، می‌توانید مسیر کامل فایل کلاس را مشخص کرده و از کاراکترهای عام (wildcard) استفاده کنید، برای مثال /home/src/java/awt/Graphics*.java. همچنین می‌توانید مسیر را نسبت به دایرکتوری جاری مشخص کنید.
- @files
- نام فایل‌هایی را مشخص می‌کند که شامل فهرستی از گزینه‌های ابزار javadoc، نام بسته‌ها و نام فایل‌های منبع به هر ترتیبی هستند.
توضیحات (DESCRIPTION)
ابزار javadoc اعلان‌ها و کامنت‌های مستندسازی را در مجموعه‌ای از فایل‌های منبع جاوا تجزیه کرده و صفحات HTML متناظری تولید می‌کند که (به‌طور پیش‌فرض) کلاس‌های عمومی و محافظت‌شده، کلاس‌های تو در تو (اما نه کلاس‌های داخلی ناشناس)، رابط‌ها، سازنده‌ها، متدها و فیلدها را توصیف می‌کنند. می‌توانید از ابزار javadoc برای تولید مستندات API یا مستندات پیاده‌سازی برای مجموعه‌ای از فایل‌های منبع استفاده کنید.
می‌توانید ابزار javadoc را بر روی کل بسته‌ها، فایل‌های منبع منفرد، یا هر دو اجرا کنید. هنگام مستندسازی کل بسته‌ها، می‌توانید از گزینه -subpackages یا برای پیمایش بازگشتی یک دایرکتوری و زیردایرکتوری‌های آن، یا برای ارسال فهرستی صریح از نام‌های بسته استفاده کنید. هنگامی که فایل‌های منبع منفرد را مستندسازی می‌کنید، فهرستی از نام‌های فایل منبع جاوا را ارسال کنید. برای کسب اطلاعات بیشتر در مورد استفاده از ابزار javadoc، بخش نمای کلی javadoc [https://www.oracle.com/pls/topic/lookup?ctx=en/java/javase/13/tools&id=JSJAV-GUID-7A344353-3BBF-45C4-8B28-15025DDCC643] در Java Platform, Standard Edition Javadoc Guide را ببینید.
انطباق و سازگاری (CONFORMANCE)
داکلت استاندارد محتوای کامنت‌های مستندسازی را برای انطباق اعتبارسنجی نمی‌کند و تلاشی برای تصحیح خطاهای موجود در کامنت‌های مستندسازی انجام نمی‌دهد. به هر کسی که javadoc را اجرا می‌کند توصیه می‌شود از مشکلاتی که ممکن است هنگام تولید خروجی ناسازگار یا خروجی حاوی محتوای اجرایی مانند جاوااسکریپت رخ دهد آگاه باشد. داکلت استاندارد ویژگی doclint را برای کمک به توسعه‌دهندگان در تشخیص مشکلات رایج در کامنت‌های مستندسازی ارائه می‌دهد؛ اما همچنین توصیه می‌شود خروجی تولیدشده با ابزارهای مناسب اعتبارسنجی انطباق و سایر ابزارهای بررسی ارزیابی شود.
برای جزئیات بیشتر در مورد الزامات انطباق برای اسناد HTML5، بخش الزامات انطباق [https://www.w3.org/TR/html5/infrastructure.html#conformance-requirements] در مشخصات HTML5 را ببینید. برای جزئیات بیشتر در مورد مسائل امنیتی مرتبط با صفحات وب، صفحه پروژه امنیت برنامه‌های کاربردی وب باز (OWASP) [https://www.owasp.org] را ببینید.
گزینه‌های JAVADOC (OPTIONS FOR JAVADOC)
گزینه‌های اصلی javadoc زیر معادل گزینه‌های متناظر در javac هستند. برای توضیحات دقیق استفاده از این گزینه‌ها، بخش گزینه‌های استاندارد در javac را ببینید:
- •
- --add-modules
- •
- -bootclasspath
- •
- --class-path، -classpath، یا -cp
- •
- --enable-preview
- •
- -encoding
- •
- -extdirs
- •
- --limit-modules
- •
- --module
- •
- --module-path یا -p
- •
- --module-source-path
- •
- --release
- •
- --source یا -source
- •
- --source-path یا -sourcepath
- •
- --system
- •
- --upgrade-module-path
گزینه‌های زیر گزینه‌های اصلی javadoc هستند که معادل گزینه متناظری در javac نیستند:
نکته:
در ابزارهایی که از گزینه‌های به سبک -- پشتیبانی می‌کنند، گزینه‌های به سبک GNU می‌توانند به جای فاصله، از علامت مساوی (=) برای جدا کردن نام یک گزینه از مقدار آن استفاده کنند.
- -breakiterator
- جمله اول را با BreakIterator محاسبه می‌کند. جمله اول در خلاصه بسته، کلاس، یا عضو و همچنین در نمایه الفبایی کپی می‌شود. کلاس BreakIterator برای تعیین پایان جمله برای همه زبان‌ها به جز انگلیسی استفاده می‌شود.
- •
- الگوریتم پیش‌فرض پایان جمله انگلیسی --- در نقطه همراه با یک فاصله یا یک تگ بلوکی HTML مانند <P> متوقف می‌شود.
- •
- الگوریتم پایان جمله Breakiterator --- در نقطه، علامت سؤال، یا علامت تعجب همراه با یک فاصله زمانی که کلمه بعدی با یک حرف بزرگ شروع می‌شود متوقف می‌شود. این برای رسیدگی به اکثر اختصارات در نظر گرفته شده است (مانند "The serial no. is valid"، اما "Mr. Smith" را پردازش نمی‌کند). گزینه -breakiterator در تگ‌های HTML یا جملاتی که با اعداد یا نمادها شروع می‌شوند متوقف نمی‌شود. این الگوریتم در آخرین نقطه در ../filename متوقف می‌شود، حتی زمانی که در یک تگ HTML جاسازی شده باشد.
- -doclet class
- خروجی را با استفاده از یک داکلت جایگزین تولید می‌کند. از نام کاملاً واجد شرایط (fully qualified) استفاده کنید. این داکلت محتوا را تعریف کرده و خروجی را قالب‌بندی می‌کند. اگر گزینه -doclet استفاده نشود، ابزار javadoc از داکلت استاندارد برای تولید فرمت پیش‌فرض HTML استفاده می‌کند. این کلاس باید شامل متد start(Root) باشد. مسیر این کلاس شروع توسط گزینه -docletpath تعریف می‌شود.
- -docletpath path
- محل یافتن فایل‌های کلاس داکلت (مشخص‌شده با گزینه -doclet) و هر فایل JAR وابسته به آن را مشخص می‌کند. اگر فایل کلاس شروع در یک فایل JAR باشد، این گزینه مسیر آن فایل JAR را مشخص می‌کند. می‌توانید یک مسیر مطلق یا یک مسیر نسبی نسبت به دایرکتوری جاری مشخص کنید. اگر classpathlist شامل چندین مسیر یا فایل JAR باشد، باید با دونقطه (:) در لینوکس و نقطه‌ویرگول (;) در ویندوز از هم جدا شوند. زمانی که کلاس شروع doclet از قبل در مسیر جستجو باشد، این گزینه ضروری نیست.
- -exclude pkglist
- به‌طور بدون قید و شرط، بسته‌های مشخص‌شده و زیربسته‌های آن‌ها را از فهرستی که توسط -subpackages تشکیل شده است مستثنی می‌کند. این گزینه آن بسته‌ها را حتی اگر توسط یک گزینه -subpackages قبلی یا بعدی گنجانده شده باشند، حذف می‌کند.
مثال زیر شامل java.io، java.util، و java.math (در میان دیگران) می‌شود، اما بسته‌های ریشه‌دار در java.net و java.lang را مستثنی می‌کند. توجه داشته باشید که این مثال‌ها java.lang.ref را که یک زیربسته از java.lang است، مستثنی می‌کنند.
- •
- لینوکس و OS X:
javadoc -sourcepath /home/user/src -subpackages java -exclude java.net:java.lang
- •
- ویندوز:
javadoc -sourcepath \user\src -subpackages java -exclude java.net:java.lang
- --expand-requires value
- به ابزار javadoc دستور می‌دهد تا مجموعه ماژول‌هایی را که باید مستندسازی شوند گسترش دهد. به‌طور پیش‌فرض، فقط ماژول‌هایی که صریحاً در خط فرمان داده شده‌اند مستندسازی می‌شوند. از مقادیر زیر پشتیبانی می‌کند:
- •
- transitive: علاوه بر این، تمام وابستگی‌های انتقالی مورد نیاز آن ماژول‌ها را نیز شامل می‌شود.
- •
- all: تمام وابستگی‌ها را شامل می‌شود.
- --help, -help, -h, or -?
- خلاصه‌ای از گزینه‌های استاندارد را چاپ می‌کند.
- --help-extra or -X
- خلاصه‌ای از مجموعه گزینه‌های اضافی را چاپ می‌کند.
- -Jflag
- فلگ flag را مستقیماً به محیط زمان اجرای جاوا (JRE) که ابزار javadoc را اجرا می‌کند ارسال می‌کند. برای مثال، اگر باید اطمینان حاصل کنید که سیستم ۳۲ مگابایت حافظه برای پردازش مستندات تولیدشده کنار می‌گذارد، گزینه -Xmx را به این صورت فراخوانی می‌کنید: javadoc -J-Xmx32m -J-Xms32m com.mypackage. توجه داشته باشید که -Xms اختیاری است زیرا فقط اندازه حافظه اولیه را تنظیم می‌کند، که زمانی مفید است که حداقل مقدار حافظه مورد نیاز را می‌دانید.
هیچ فاصله‌ای بین J و flag وجود ندارد.
از گزینه -version برای گزارش نسخه JRE مورد استفاده برای اجرای ابزار javadoc استفاده کنید.
-
javadoc -J-version java version "10-ea" 2018-03-20 Java(TM) SE Runtime Environment 18.3 (build 10-ea+36) Java HotSpot(TM) 64-Bit Server VM 18.3 (build 10-ea+36, mixed mode)
- -locale name
- محلی (locale) را که ابزار javadoc هنگام تولید مستندات استفاده می‌کند مشخص می‌سازد. آرگومان نام محلی است، همان‌طور که در مستندات java.util.Locale شرح داده شده است، مانند en_US (انگلیسی، ایالات متحده) یا en_US_WIN (گونه ویندوز).
نکته:
گزینه -locale باید جلوتر (در سمت چپ) هر گزینه‌ای قرار گیرد که توسط داکلت استاندارد یا هر داکلت دیگری ارائه می‌شود. در غیر این صورت، نوارهای ناوبری به زبان انگلیسی ظاهر می‌شوند. این تنها گزینه خط فرمان است که به ترتیب قرارگیری وابسته است.
مشخص کردن یک محلی باعث می‌شود ابزار javadoc فایل‌های منبع آن محلی را برای پیام‌هایی مانند رشته‌های نوار ناوبری، سربرگ‌های فهرست‌ها و جداول، محتوای فایل راهنما، کامنت‌های موجود در فایل stylesheet.css و غیره انتخاب کند. همچنین ترتیب مرتب‌سازی فهرست‌های مرتب‌شده بر اساس الفبا و جداکننده جمله را برای تعیین پایان جمله اول مشخص می‌کند. گزینه -locale محلی متن کامنت مستندسازی مشخص‌شده در فایل‌های منبع کلاس‌های مستندشده را تعیین نمی‌کند.
- -package
- فقط کلاس‌ها و اعضای بسته، محافظت‌شده و عمومی را نمایش می‌دهد.
- -private
- همه کلاس‌ها و اعضا را نمایش می‌دهد.
- -protected
- فقط کلاس‌ها و اعضای محافظت‌شده و عمومی را نمایش می‌دهد. این حالت پیش‌فرض است.
- -public
- فقط کلاس‌ها و اعضای عمومی را نمایش می‌دهد.
- -quiet
- پیام‌ها را خاموش می‌کند تا فقط هشدارها و خطاها ظاهر شوند تا مشاهده آن‌ها آسان‌تر شود. همچنین رشته version را سرکوب می‌کند.
- --show-members value
- مشخص می‌کند کدام اعضا (فیلدها یا متدها) مستندسازی شوند، که در آن value می‌تواند هر یک از موارد زیر باشد:
- •
- protected: مقدار پیش‌فرض protected است.
- •
- public: فقط مقادیر عمومی را نمایش می‌دهد.
- •
- package: اعضای عمومی، محافظت‌شده و بسته را نمایش می‌دهد.
- •
- private: تمام اعضا را نمایش می‌دهد.
- --show-module-contents value
- سطح جزئیات مستندسازی اعلان‌های ماژول را مشخص می‌کند، که در آن value می‌تواند api یا all باشد.
- --show-packages value
- مشخص می‌کند کدام بسته‌های ماژول مستندسازی شوند، که در آن value می‌تواند بسته‌های صادرشده (exported) یا تمام بسته‌ها (all) باشد.
- --show-types value
- مشخص می‌کند کدام نوع‌ها (کلاس‌ها، رابط‌ها و غیره) مستندسازی شوند، که در آن value می‌تواند هر یک از موارد زیر باشد:
- •
- protected: مقدار پیش‌فرض. نوع‌های عمومی و محافظت‌شده را نمایش می‌دهد.
- •
- public: فقط مقادیر عمومی را نمایش می‌دهد.
- •
- package: نوع‌های عمومی، محافظت‌شده و بسته را نمایش می‌دهد.
- •
- private: تمام نوع‌ها را نمایش می‌دهد.
- -subpackages subpkglist
- مستندات را از فایل‌های منبع در بسته‌های مشخص‌شده و به‌طور بازگشتی در زیربسته‌های آن‌ها تولید می‌کند. این گزینه هنگام افزودن زیربسته‌های جدید به کد منبع مفید است زیرا آن‌ها به‌طور خودکار گنجانده می‌شوند. هر آرگومان بسته، هر زیربسته سطح بالا (مانند java) یا بسته کاملاً واجد شرایط (مانند javax.swing) است که نیازی به داشتن فایل‌های منبع ندارد. آرگومان‌ها در تمام سیستم‌های عامل با دونقطه از هم جدا می‌شوند. استفاده از کاراکترهای عام (wildcard) مجاز نیست. از -sourcepath برای مشخص کردن محل یافتن بسته‌ها استفاده کنید. این گزینه فایل‌های منبعی را که در درخت منبع هستند اما به بسته‌ها تعلق ندارند پردازش نمی‌کند.
برای مثال، دستورات زیر مستندات را برای بسته‌هایی به نام java و javax.swing و تمام زیربسته‌های آن‌ها تولید می‌کنند.
- •
- لینوکس و OS X:
javadoc -d docs -sourcepath /home/user/src -subpackages java:javax.swing
- •
- ویندوز:
javadoc -d docs -sourcepath \user\src -subpackages java:javax.swing
- -verbose
- پیام‌های با جزئیات بیشتر را در حین اجرای ابزار javadoc ارائه می‌دهد. بدون گزینه -verbose، پیام‌ها برای بارگیری فایل‌های منبع، تولید مستندات (یک پیام به ازای هر فایل منبع) و مرتب‌سازی ظاهر می‌شوند. گزینه -verbose باعث چاپ پیام‌های اضافی می‌شود که تعداد میلی‌ثانیه‌ها را برای تجزیه هر فایل منبع جاوا مشخص می‌کند.
- --version
- اطلاعات نسخه را چاپ می‌کند.
- -Werror
- در صورت بروز هرگونه هشدار، یک خطا گزارش می‌دهد.
گزینه‌های گسترش‌یافته (EXTENDED OPTIONS)
نکته:
گزینه‌های گسترش‌یافته برای javadoc ممکن است بدون اطلاع قبلی تغییر کنند.
گزینه‌های گسترش‌یافته javadoc زیر معادل گزینه‌های متناظر در javac هستند. برای توضیحات دقیق استفاده از این گزینه‌ها، بخش گزینه‌های اضافی در javac را ببینید:
- •
- --add-exports
- •
- --add-reads
- •
- --patch-module
- •
- -Xmaxerrs
- •
- -Xmaxwarns
گزینه‌های داکلت استاندارد (STANDARD DOCLET OPTIONS)
گزینه‌های زیر توسط داکلت استاندارد ارائه شده‌اند.
- --add-stylesheet file
- یک فایل شیوه‌نامه (stylesheet) اضافی به مستندات تولیدشده اضافه می‌کند. این گزینه می‌تواند یک یا چند بار برای مشخص کردن شیوه‌نامه‌های اضافی گنجانده‌شده در مستندات استفاده شود.
مثال خط فرمان:
javadoc --add-stylesheet new_stylesheet_1.css --add-stylesheet new_stylesheet_2.css pkg_foo
- --allow-script-in-comments
- به جاوااسکریپت در گزینه‌ها و کامنت‌ها اجازه می‌دهد.
- متن @author را در اسناد تولیدشده شامل می‌شود.
- -bottom html-code
- متنی را که باید در پایین هر فایل خروجی قرار گیرد مشخص می‌کند. متن در پایین صفحه، زیر نوار ناوبری پایینی قرار می‌گیرد. متن می‌تواند حاوی تگ‌های HTML و فاصله باشد، اما در این صورت، متن باید در علامت نقل‌قول قرار گیرد. برای هرگونه علامت نقل‌قول داخلی در متن، از نویسه‌های گریز (escape) استفاده کنید.
- -charset name
- مجموعه نویسه (character set) HTML را برای این سند مشخص می‌کند. نام باید یک نام ترجیحی MIME باشد همان‌طور که در ثبت IANA، مجموعه‌های نویسه [http://www.iana.org/assignments/character-sets] مشخص شده است.
برای مثال:
javadoc -charset "iso-8859-1" mypackage
این دستور خط زیر را در سربرگ هر صفحه تولیدشده درج می‌کند:
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
تگ META در استاندارد HTML (4197265 و 4137321)، نمایش سند HTML [http://www.w3.org/TR/REC-html40/charset.html#h-5.2.2] شرح داده شده است.
- -d directory
- دایرکتوری مقصدی را مشخص می‌کند که ابزار javadoc فایل‌های HTML تولیدشده را در آن ذخیره می‌کند. اگر گزینه -d را حذف کنید، فایل‌ها در دایرکتوری جاری ذخیره می‌شوند. مقدار directory می‌تواند مطلق یا نسبی نسبت به دایرکتوری کاری جاری باشد. دایرکتوری مقصد هنگام اجرای ابزار javadoc به‌طور خودکار ایجاد می‌شود.
- •
- لینوکس و OS X: برای مثال، دستور زیر مستندات را برای بسته com.mypackage تولید کرده و نتایج را در دایرکتوری /user/doc/ ذخیره می‌کند:
javadoc -d /user/doc/ com.mypackage
- •
- ویندوز: برای مثال، دستور زیر مستندات را برای بسته com.mypackage تولید کرده و نتایج را در دایرکتوری \user\doc\ ذخیره می‌کند:
javadoc -d \user\doc\ com.mypackage
- -docencoding name
- کدگذاری فایل‌های HTML تولیدشده را مشخص می‌کند. نام باید یک نام ترجیحی MIME باشد همان‌طور که در ثبت IANA، مجموعه‌های نویسه [http://www.iana.org/assignments/character-sets] مشخص شده است.
سه گزینه برای استفاده در دستور کدگذاری javadoc موجود است. گزینه -encoding برای کدگذاری فایل‌های خوانده‌شده توسط ابزار javadoc استفاده می‌شود، در حالی که گزینه‌های -docencoding و -charset برای کدگذاری فایل‌های نوشته‌شده توسط ابزار استفاده می‌شوند. از سه گزینه موجود، حداکثر یک گزینه کدگذاری ورودی و یک گزینه کدگذاری خروجی در یک دستور کدگذاری استفاده می‌شوند. اگر هر دو گزینه کدگذاری ورودی و خروجی را در یک دستور مشخص کنید، باید مقدار یکسانی داشته باشند. اگر هیچ گزینه خروجی را مشخص نکنید، ابزار به‌طور پیش‌فرض از کدگذاری ورودی استفاده می‌کند.
برای مثال:
javadoc -docencoding "iso-8859-1" mypackage
- -docfilessubdirs
- زیردایرکتوری‌های doc-file را به‌طور بازگشتی کپی می‌کند. کپی عمیق دایرکتوری‌های doc-files را فعال می‌کند. زیردایرکتوری‌ها و تمام محتویات به‌طور بازگشتی در مقصد کپی می‌شوند. برای مثال، دایرکتوری doc-files/example/images و تمام محتویات آن کپی می‌شوند. همچنین گزینه‌ای برای مستثنی کردن زیردایرکتوری‌ها وجود دارد.
- -doctitle html-code
- عنوانی را برای قرار دادن نزدیک بالای فایل خلاصه نمای کلی (overview summary) مشخص می‌کند. متن مشخص‌شده در تگ title به عنوان یک سربرگ سطح اولِ وسط‌چین، مستقیماً زیر نوار ناوبری بالایی قرار می‌گیرد. تگ title می‌تواند حاوی تگ‌های HTML و فاصله باشد، اما در این صورت باید عنوان را در علامت نقل‌قول قرار دهید. علامت‌های نقل‌قول اضافی در تگ title باید گریز داده شوند (escaped). برای مثال، javadoc -doctitle "<b>My Library</b><br>v1.0" com.mypackage.
- -excludedocfilessubdir name
- هر زیردایرکتوری doc files با نام داده‌شده را مستثنی می‌کند. بخش -docfilessubdirs را ببینید.
- متن پاورقی را برای قرار دادن در پایین هر فایل خروجی مشخص می‌کند. مقدار html-code در سمت راست نوار ناوبری پایینی قرار می‌گیرد. مقدار html-code می‌تواند حاوی تگ‌های HTML و فاصله باشد، اما در این صورت، مقدار html-code باید در علامت نقل‌قول قرار گیرد. از نویسه‌های گریز برای هرگونه علامت نقل‌قول داخلی در پاورقی استفاده کنید.
- -group namep1:p2
- بسته‌های مشخص‌شده را در صفحه نمای کلی (Overview) با هم گروه‌بندی می‌کند.
- -header html-code
- متن سربرگ را برای قرار دادن در بالای هر فایل خروجی مشخص می‌کند. سربرگ در سمت راست نوار ناوبری بالایی قرار می‌گیرد. مقدار header می‌تواند حاوی تگ‌های HTML و فاصله باشد، اما در این صورت، header باید در علامت نقل‌قول قرار گیرد. از نویسه‌های گریز برای علامت‌های نقل‌قول داخلی در سربرگ استفاده کنید. برای مثال، javadoc -header "<b>My Library</b><br>v1.0" com.mypackage.
- -helpfile filename
- فایلی را که به پیوند HELP در نوارهای ناوبری بالا و پایین متصل می‌شود، شامل می‌سازد. بدون این گزینه، ابزار javadoc یک فایل راهنما به نام help-doc.html ایجاد می‌کند که در ابزار javadoc به صورت کد سخت قرار دارد. این گزینه به شما امکان می‌دهد مقدار پیش‌فرض را لغو کنید. filename می‌تواند هر نامی باشد و محدود به help-doc.html نیست. ابزار javadoc پیوندهای موجود در نوار ناوبری را بر این اساس تنظیم می‌کند. برای مثال:
- •
- لینوکس و OS X:
javadoc -helpfile /home/user/myhelp.html java.awt.
- •
- ویندوز:
javadoc -helpfile C:\user\myhelp.html java.awt.
- -html5
- این گزینه بی‌اثر (no-op) است و صرفاً برای سازگاری با گذشته حفظ شده است.
- --javafx or -javafx
- قابلیت JavaFX را فعال می‌کند.
- -keywords
- تگ‌های کلمه کلیدی <META> در HTML را برای هر کلاس به فایل تولیدشده اضافه می‌کند. این تگ‌ها می‌توانند به موتورهای جستجویی که به دنبال تگ‌های <META> می‌گردند در یافتن صفحات کمک کنند. اکثر موتورهای جستجو که کل اینترنت را جستجو می‌کنند به تگ‌های <META> نگاه نمی‌کنند، زیرا صفحات ممکن است از آن‌ها سوءاستفاده کنند. موتورهای جستجوی ارائه‌شده توسط شرکت‌هایی که جستجوهای خود را به وب‌سایت خود محدود می‌کنند، می‌توانند از بررسی تگ‌های <META> بهره‌مند شوند. تگ‌های <META> شامل نام کاملاً واجد شرایط کلاس و نام‌های غیر واجد شرایط فیلدها و متدها هستند. سازنده‌ها گنجانده نمی‌شوند زیرا با نام کلاس یکسان هستند. برای مثال، کلاس String با این کلمات کلیدی شروع می‌شود:
-
<META NAME="keywords" CONTENT="java.lang.String class"> <META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER"> <META NAME="keywords" CONTENT="length()"> <META NAME="keywords" CONTENT="charAt()">
- -link url
- پیوندهایی به مستندات موجودِ تولیدشده توسط javadoc از کلاس‌های دارای ارجاع خارجی ایجاد می‌کند. آرگومان url نشانی وب مطلق یا نسبی دایرکتوری حاوی مستندات تولیدشده خارجی javadoc است. می‌توانید چندین گزینه -link را در یک اجرای ابزار javadoc مشخص کنید تا به چندین سند پیوند داده شود.
باید یک فایل package-list یا element-list در این دایرکتوری url وجود داشته باشد (در غیر این صورت، از گزینه -linkoffline استفاده کنید).
نکته:
فایل‌های package-list و element-list توسط ابزار javadoc هنگام تولید مستندات API ایجاد می‌شوند و نباید توسط کاربر تغییر داده شوند.
هنگامی که از ابزار javadoc برای مستندسازی بسته‌ها استفاده می‌کنید، از فایل package-list برای تعیین بسته‌های اعلان‌شده در یک API استفاده می‌کند. هنگامی که اسناد API را برای ماژول‌ها تولید می‌کنید، ابزار javadoc از فایل element-list برای تعیین ماژول‌ها و بسته‌های اعلان‌شده در یک API استفاده می‌کند.
ابزار javadoc نام‌ها را از فایل فهرست مناسب می‌خواند و سپس به بسته‌ها یا ماژول‌ها در آن نشانی وب پیوند می‌دهد.
هنگامی که ابزار javadoc اجرا می‌شود، مقدار url در پیوندهای <A HREF> ایجادشده کپی می‌شود. بنابراین، url باید نشانی وب دایرکتوری باشد و نه یک فایل.
می‌توانید از پیوند مطلق برای url استفاده کنید تا اسناد شما بتوانند به سندی در هر وب‌سایتی پیوند داده شوند، یا می‌توانید از پیوند نسبی برای پیوند دادن صرفاً به یک مکان نسبی استفاده کنید. اگر از پیوند نسبی استفاده می‌کنید، مقداری که ارسال می‌کنید باید مسیر نسبی از دایرکتوری مقصد (مشخص‌شده با گزینه -d) به دایرکتوری حاوی بسته‌های پیوندشده باشد. هنگامی که یک پیوند مطلق را مشخص می‌کنید، معمولاً از پیوند HTTP استفاده می‌کنید. با این حال، اگر می‌خواهید به یک فایل‌سیستم که فاقد وب‌سرور است پیوند دهید، می‌توانید از پیوند فایل استفاده کنید. تنها زمانی از پیوند فایل استفاده کنید که هر کسی که می‌خواهد به مستندات تولیدشده دسترسی داشته باشد، همان سیستم فایل را به اشتراک بگذارد. در همه موارد و در تمام سیستم‌های عامل، از اسلش به عنوان جداکننده استفاده کنید، چه URL مطلق باشد یا نسبی، و https:، http:، یا file: همان‌طور که در یادداشت URL: مکان‌یاب‌های یکنواخت منبع [http://www.ietf.org/rfc/rfc1738.txt] مشخص شده است.
-
-link https://<host>/<directory>/<directory>/.../<name> -link http://<host>/<directory>/<directory>/.../<name> -link file://<host>/<directory>/<directory>/.../<name> -link <directory>/<directory>/.../<name>
- -linkoffline url1 url2
- این گزینه گونه‌ای از گزینه -link است. هر دوی آن‌ها پیوندهایی به مستندات تولیدشده javadoc برای کلاس‌های دارای ارجاع خارجی ایجاد می‌کنند. می‌توانید چندین گزینه -linkoffline را در یک اجرای ابزار javadoc مشخص کنید.
از گزینه -linkoffline در موارد زیر استفاده کنید:
- •
- پیوند دادن به سندی در وب که ابزار javadoc نمی‌تواند از طریق اتصال وب به آن دسترسی داشته باشد
- •
- فایل package-list یا element-list سند خارجی یا قابل دسترسی نیست یا در مکان URL وجود ندارد، اما در مکان دیگری وجود دارد و می‌تواند توسط فایل package-list یا element-list (معمولاً محلی) مشخص شود.
نکته:
فایل‌های package-list و element-list توسط ابزار javadoc هنگام تولید مستندات API ایجاد می‌شوند و نباید توسط کاربر تغییر داده شوند.
اگر url1 فقط در شبکه جهانی وب قابل دسترسی باشد، گزینه -linkoffline این محدودیت را که ابزار javadoc برای تولید مستندات باید اتصال وب داشته باشد برطرف می‌کند.
کاربرد دیگر گزینه -linkoffline به عنوان یک راه حل موقت برای به‌روزرسانی اسناد است. پس از اجرای ابزار javadoc روی مجموعه کاملی از بسته‌ها یا ماژول‌ها، می‌توانید ابزار javadoc را مجدداً روی مجموعه کوچک‌تری از بسته‌ها یا ماژول‌های تغییریافته اجرا کنید، تا فایل‌های به‌روزرسانی‌شده بتوانند دوباره در مجموعه اصلی درج شوند.
برای مثال، گزینه -linkoffline دو آرگومان می‌گیرد. اولی برای رشته‌ای است که باید در پیوندهای <a href> تعبیه شود، و دومی به ابزار javadoc می‌گوید فایل package-list یا element-list را کجا پیدا کند.
مقدار url1 یا url2 نشانی وب مطلق یا نسبی دایرکتوری حاوی مستندات تولیدشده خارجی javadoc است که می‌خواهید به آن پیوند دهید. در صورت نسبی بودن، مقدار باید مسیر نسبی از دایرکتوری مقصد (مشخص‌شده با گزینه -d) به ریشه بسته‌های پیوندشده باشد. بخش url در گزینه -link را ببینید.
- -linksource
- یک نسخه HTML از هر فایل منبع (همراه با شماره خطوط) ایجاد کرده و پیوندهایی به آن‌ها از مستندات استاندارد HTML اضافه می‌کند. پیوندها برای کلاس‌ها، رابط‌ها، سازنده‌ها، متدها و فیلدهایی که اعلان‌های آن‌ها در یک فایل منبع است ایجاد می‌شوند. در غیر این صورت، پیوندها ایجاد نمی‌شوند، مانند سازنده‌های پیش‌فرض و کلاس‌های تولیدشده.
این گزینه تمام جزئیات پیاده‌سازی خصوصی را در فایل‌های منبع گنجانده‌شده، شامل کلاس‌های خصوصی، فیلدهای خصوصی و بدنه متدهای خصوصی، بدون در نظر گرفتن گزینه‌های -public، -package، -protected و -private نمایش می‌دهد. مگر اینکه از گزینه -private نیز استفاده کنید، تمام کلاس‌ها یا رابط‌های خصوصی از طریق پیوندها قابل دسترسی نیستند.
هر پیوند روی نام شناسه در اعلان آن ظاهر می‌شود. برای مثال، پیوند به کد منبع کلاس Button روی کلمه Button خواهد بود:
public class Button extends Component implements Accessible
پیوند به کد منبع متد getLabel در کلاس Button روی کلمه getLabel قرار دارد:
public String getLabel()
- --main-stylesheet file or -stylesheetfile file
- مسیر یک فایل شیوه‌نامه جایگزین را مشخص می‌کند که شامل تعاریف سبک‌های CSS مورد استفاده در مستندات تولیدشده است. این گزینه به شما امکان می‌دهد مقدار پیش‌فرض را لغو کنید. اگر این گزینه را مشخص نکنید، ابزار javadoc یک شیوه‌نامه پیش‌فرض ایجاد کرده و از آن استفاده می‌کند. نام فایل می‌تواند هر نامی باشد و به stylesheet.css محدود نمی‌شود. گزینه --main-stylesheet فرم ترجیحی است.
مثال خط فرمان:
javadoc --main-stylesheet main_stylesheet.css pkg_foo
- -nocomment
- کل بدنه کامنت، از جمله توضیحات اصلی و همه تگ‌ها را سرکوب کرده و فقط اعلان‌ها را تولید می‌کند. این گزینه به شما امکان می‌دهد از فایل‌های منبعی که در ابتدا برای هدف دیگری در نظر گرفته شده بودند مجدداً استفاده کنید تا بتوانید در مراحل اولیه یک پروژه جدید، اسکلت مستندات HTML را تولید نمایید.
- -nodeprecated
- از تولید هرگونه API منسوخ‌شده (deprecated) در مستندات جلوگیری می‌کند. این کار همان کاری را انجام می‌دهد که گزینه -nodeprecatedlist انجام می‌دهد، به علاوه در بقیه بخش‌های مستندات نیز هیچ API منسوخ‌شده‌ای تولید نمی‌کند. این گزینه هنگام نوشتن کد زمانی که نمی‌خواهید حواستان با کدهای منسوخ‌شده پرت شود مفید است.
- -nodeprecatedlist
- از تولید فایلی که حاوی فهرست APIهای منسوخ‌شده است (deprecated-list.html) و پیوند موجود در نوار ناوبری به آن صفحه جلوگیری می‌کند. ابزار javadoc به تولید API منسوخ‌شده در سرتاسر بقیه سند ادامه می‌دهد. این گزینه زمانی مفید است که کد منبع شما حاوی هیچ API منسوخ‌شده‌ای نباشد و بخواهید نوار ناوبری تمیزتری داشته باشید.
- --no-frames
- این گزینه بی‌اثر (no-op) است و صرفاً برای سازگاری با گذشته حفظ شده است.
- -nohelp
- پیوند HELP را در نوارهای ناوبری بالا و پایین هر صفحه خروجی حذف می‌کند.
- -noindex
- نمایه (index) را از اسناد تولیدشده حذف می‌کند. نمایه به‌طور پیش‌فرض تولید می‌شود.
- از تولید نوار ناوبری، سربرگ و پاورقی که معمولاً در بالا و پایین صفحات تولیدشده یافت می‌شوند، جلوگیری می‌کند. گزینه -nonavbar هیچ تأثیری بر گزینه -bottom ندارد. گزینه -nonavbar زمانی مفید است که فقط به محتوا علاقه‌مند هستید و نیازی به ناوبری ندارید، مانند زمانی که فایل‌ها را صرفاً برای چاپ به PostScript یا PDF تبدیل می‌کنید.
- -noqualifier name1:name2...
- فهرست واجد شرایط‌کننده‌ها (qualifiers) را از خروجی حذف می‌کند. نام بسته از جاهایی که نام کلاس یا رابط ظاهر می‌شود حذف می‌شود.
مثال زیر تمام واجد شرایط‌کننده‌های بسته را حذف می‌کند: -noqualifier all.
مثال زیر واجد شرایط‌کننده‌های بسته‌های java.lang و java.io را حذف می‌کند: -noqualifier java.lang:java.io.
مثال زیر واجد شرایط‌کننده‌های بسته‌هایی را که با زیربسته‌های java و com.sun شروع می‌شوند حذف می‌کند، اما javax را حذف نمی‌کند: -noqualifier java.*:com.sun.*.
در جایی که یک واجد شرایط‌کننده بسته به دلیل رفتار قبلی ظاهر می‌شود، نام می‌تواند به شکل مناسب کوتاه شود. این قاعده بدون در نظر گرفتن اینکه آیا از گزینه -noqualifier استفاده شده است یا خیر، اعمال می‌شود.
- -nosince
- بخش‌های Since مرتبط با تگ‌های @since را از اسناد تولیدشده حذف می‌کند.
- -notimestamp
- برچسب زمانی را که در یک کامنت HTML در بالای هر صفحه مخفی شده است، سرکوب می‌کند. گزینه -notimestamp زمانی مفید است که می‌خواهید ابزار javadoc را روی دو پایگاه منبع اجرا کنید و تفاوت‌های بین آن‌ها را با diff بگیرید، زیرا از ایجاد تفاوت توسط برچسب‌های زمانی جلوگیری می‌کند (که در غیر این صورت در هر صفحه یک diff ایجاد می‌شد). برچسب زمانی شامل شماره انتشار ابزار javadoc است.
- -notree
- صفحات سلسله‌مراتب کلاس و رابط را از اسناد تولیدشده حذف می‌کند. این‌ها صفحاتی هستند که با استفاده از دکمه Tree در نوار ناوبری به آن‌ها می‌رسید. سلسله‌مراتب به‌طور پیش‌فرض تولید می‌شود.
- --override-methods (detail|summary)
- متدهای بازنویسی‌شده (overridden) را در بخش‌های جزئیات یا خلاصه مستندسازی می‌کند.
- -overview filename
- مشخص می‌کند که ابزار javadoc باید متن مستندات نمای کلی را از فایل منبع مشخص‌شده توسط filename بازیابی کند و آن را در صفحه نمای کلی (overview-summary.html) قرار دهد. یک مسیر نسبی مشخص‌شده با نام فایل، نسبت به دایرکتوری کاری جاری است.
در حالی که می‌توانید از هر نامی که می‌خواهید برای مقدار filename استفاده کنید و آن را در هر کجای مسیر قرار دهید، معمول است که نام آن را overview.html بگذارید و آن را در درخت منبع در دایرکتوری حاوی بالاترین دایرکتوری‌های بسته قرار دهید. در این مکان، هنگام مستندسازی بسته‌ها به هیچ مسیری نیاز نیست، زیرا گزینه -sourcepath به این فایل اشاره می‌کند.
- •
- لینوکس و OS X: برای مثال، اگر درخت منبع برای بسته java.lang به صورت /src/classes/java/lang/ باشد، می‌توانید فایل نمای کلی را در /src/classes/overview.html قرار دهید.
- •
- ویندوز: برای مثال، اگر درخت منبع برای بسته java.lang به صورت \src\classes\java\lang\ باشد، می‌توانید فایل نمای کلی را در \src\classes\overview.html قرار دهید.
صفحه نمای کلی تنها زمانی ایجاد می‌شود که دو یا چند نام بسته را به ابزار javadoc ارسال کنید. عنوان صفحه نمای کلی توسط -doctitle تنظیم می‌شود.
- -serialwarn
- هشدارهای زمان کامپایل را برای تگ‌های گم‌شده @serial تولید می‌کند. به‌طور پیش‌فرض، Javadoc هیچ هشدار سریالی تولید نمی‌کند. از این گزینه برای نمایش هشدارهای سریال استفاده کنید، که به مستندسازی صحیح فیلدهای سریالی‌شدنی پیش‌فرض و متدهای writeExternal کمک می‌کند.
- -sourcetab tablength
- تعداد فاصله‌هایی را که هر تب در منبع استفاده می‌کند مشخص می‌سازد.
- -splitindex
- فایل نمایه را به چندین فایل به صورت الفبایی تقسیم می‌کند، یک فایل برای هر حرف، به علاوه یک فایل برای مدخل‌های نمایه‌ای که با نمادهای غیر الفبایی شروع می‌شوند.
- -tag name:locations:header
- تگ‌های سفارشی تک‌آرگومانی را مشخص می‌کند. برای اینکه ابزار javadoc املای نام تگ‌ها را بررسی کند، مهم است که برای هر تگ سفارشی موجود در کد منبع یک گزینه -tag قرار دهید و تگ‌هایی را که در اجرای فعلی خروجی داده نمی‌شوند (با X) غیرفعال کنید. دونقطه (:) همیشه جداکننده است. گزینه -tag عنوان تگ، header را به صورت بولد در خروجی نمایش می‌دهد و در خط بعدی متن ناشی از تک آرگومان آن قرار می‌گیرد. مشابه هر تگ بلوکی، متن آرگومان می‌تواند حاوی تگ‌های درون‌خطی (inline) باشد که آن‌ها نیز تفسیر می‌شوند. خروجی شبیه به تگ‌های تک‌آرگومانی استاندارد مانند تگ‌های @return و @author است. حذف مقدار header باعث می‌شود که name به عنوان سربرگ در نظر گرفته شود.
- -taglet class
- نام کاملاً واجد شرایط تگ‌لتی را که در تولید مستندات برای آن تگ استفاده می‌شود مشخص می‌کند. از نام کاملاً واجد شرایط برای مقدار class استفاده کنید. این تگ‌لت همچنین تعداد آرگومان‌های متنی را که تگ سفارشی دارد تعریف می‌کند. تگ‌لت آن آرگومان‌ها را می‌پذیرد، آن‌ها را پردازش می‌کند و خروجی را تولید می‌نماید.
تگ‌لت‌ها برای تگ‌های بلوکی یا درون‌خطی مفید هستند. آن‌ها می‌توانند هر تعداد آرگومان داشته باشند و رفتارهای سفارشی را پیاده‌سازی کنند، مانند بولد کردن متن، قالب‌بندی بالت‌ها، نوشتن متن در یک فایل، یا راه‌اندازی فرآیندهای دیگر. تگ‌لت‌ها فقط می‌توانند تعیین کنند که یک تگ در کجا و به چه شکلی ظاهر شود. تمام تصمیمات دیگر توسط داکلت گرفته می‌شود. یک تگ‌لت نمی‌تواند کارهایی مانند حذف نام کلاس از فهرست کلاس‌های گنجانده‌شده را انجام دهد. با این حال، می‌تواند اثرات جانبی مانند چاپ متن تگ در یک فایل یا راه‌اندازی فرآیند دیگری را اجرا کند. از گزینه -tagletpath برای مشخص کردن مسیر تگ‌لت استفاده کنید. مثال زیر تگ‌لت To Do را بعد از Parameters و جلوتر از Throws در صفحات تولیدشده درج می‌کند.
-
-taglet com.sun.tools.doclets.ToDoTaglet -tagletpath /home/taglets -tag return -tag param -tag todo -tag throws -tag see
به صورت متناوب، می‌توانید از گزینه -taglet به جای گزینه -tag آن استفاده کنید، اما خواندن آن ممکن است دشوار باشد.
- -tagletpath tagletpathlist
- مسیرهای جستجو را برای یافتن فایل‌های کلاس تگ‌لت مشخص می‌کند. tagletpathlist می‌تواند شامل چندین مسیر باشد که با جداکننده مسیر پلتفرم (; در ویندوز؛ : در سایر پلتفرم‌ها) از هم جدا شده‌اند. ابزار javadoc تمام زیردایرکتوری‌های مسیرهای مشخص‌شده را جستجو می‌کند.
- -top html-code
- متنی را برای قرار دادن در بالای هر فایل خروجی مشخص می‌کند.
- -use
- صفحات استفاده (use) از کلاس و بسته را ایجاد می‌کند. شامل یک صفحه Use برای هر کلاس و بسته مستندشده است. این صفحه توصیف می‌کند چه بسته‌ها، کلاس‌ها، متدها، سازنده‌ها و فیلدهایی از هر API کلاس یا بسته مشخص‌شده استفاده می‌کنند. برای کلاس مفروض C، مواردی که از کلاس C استفاده می‌کنند شامل زیرکلاس‌های C، فیلدهای اعلان‌شده به عنوان C، متدهایی که C را برمی‌گردانند، و متدها و سازنده‌هایی با پارامترهایی از نوع C هستند. برای مثال، می‌توانید به صفحه Use برای نوع String نگاه کنید. از آنجا که متد getName در کلاس java.awt.Font نوع String را برمی‌گرداند، متد getName از String استفاده می‌کند و بنابراین متد getName در صفحه Use برای String ظاهر می‌شود. این گزینه فقط استفاده از API را مستند می‌کند، نه پیاده‌سازی را. هنگامی که یک متد از String در پیاده‌سازی خود استفاده می‌کند، اما یک رشته را به عنوان آرگومان نمی‌گیرد یا رشته‌ای را برنمی‌گرداند، این به عنوان استفاده از String در نظر گرفته نمی‌شود. برای دسترسی به صفحه تولیدشده Use، به کلاس یا بسته بروید و روی پیوند Use در نوار ناوبری کلیک کنید.
- -version
- متن نسخه را در اسناد تولیدشده شامل می‌کند. این متن به‌طور پیش‌فرض حذف شده است. برای فهمیدن اینکه از چه نسخه‌ای از ابزار javadoc استفاده می‌کنید، از گزینه -J-version استفاده نمایید.
- -windowtitle title
- عنوانی را برای قرار دادن در تگ HTML <title> مشخص می‌کند. متن مشخص‌شده در تگ title در عنوان پنجره و در هر بوک‌مارک مرورگری (مکان‌های مورد علاقه) که شخصی برای این صفحه ایجاد می‌کند ظاهر می‌شود. این عنوان نباید حاوی هیچ تگ HTML باشد زیرا مرورگر آن‌ها را به درستی تفسیر نمی‌کند. برای هر علامت نقل‌قول داخلی در تگ title از نویسه‌های گریز استفاده کنید. اگر گزینه -windowtitle حذف شود، ابزار javadoc از مقدار گزینه -doctitle برای گزینه -windowtitle استفاده می‌کند. برای مثال، javadoc -windowtitle "My Library" com.mypackage.
گزینه‌های اضافی ارائه‌شده توسط داکلت استاندارد (ADDITIONAL OPTIONS PROVIDED BY THE STANDARD DOCLET)
گزینه‌های زیر گزینه‌های اضافی ارائه‌شده توسط داکلت استاندارد هستند و ممکن است بدون اطلاع قبلی تغییر کنند. گزینه‌های اضافی کمتر استفاده می‌شوند یا در غیر این صورت پیشرفته در نظر گرفته می‌شوند.
- -Xdoclint
- بررسی‌های توصیه‌شده را برای مشکلات موجود در کامنت‌های مستندسازی فعال می‌کند.
- -Xdoclint:(all|none|[-]group)
- بررسی‌های خاص را برای ارجاعات نامعتبر، مسائل دسترس‌پذیری، کامنت‌های مستندسازی گم‌شده، خطاهای نحوی در کامنت‌های مستندسازی و تگ‌های HTML گم‌شده فعال یا غیرفعال می‌کند.
این گزینه به ابزار javadoc امکان می‌دهد تمام کامنت‌های مستندسازی گنجانده‌شده در خروجی تولیدشده را بررسی کند. می‌توانید با گزینه‌های استاندارد -public، -protected، -package و -private انتخاب کنید که کدام موارد در خروجی تولیدشده گنجانده شوند.
هنگامی که گزینه -Xdoclint فعال است، مشکلات را با پیام‌هایی مشابه دستور javac گزارش می‌دهد. ابزار javadoc یک پیام، کپی‌ای از خط کد منبع، و یک علامت هشتک (caret) که به موقعیت دقیق شناسایی خطا اشاره می‌کند چاپ می‌نماید. پیام‌ها ممکن است بسته به شدت آن‌ها و احتمال ایجاد خطا در صورت اجرای مستندات تولیدشده در یک اعتبارسنج (validator)، هشدار یا خطا باشند. برای مثال: کامنت‌های مستندسازی گم‌شده، اطلاعات تکراری و کامنت‌های اضافی باعث نمی‌شوند ابزار javadoc خروجی HTML نامعتبر تولید کند، بنابراین این مشکلات به عنوان هشدار گزارش می‌شوند؛ خطاهای نحوی، تگ‌های پایانی ضروری HTML گم‌شده، و ارجاع به عناصر گم‌شده یا دارای غلط املایی باعث می‌شوند ابزار javadoc خروجی نامعتبر تولید کند، بنابراین این مشکلات به عنوان خطا گزارش می‌شوند.
گزینه -Xdoclint کامنت‌های ورودی را بر اساس نشانه‌گذاری درخواستی اعتبارسنجی می‌کند.
به‌طور پیش‌فرض، گزینه -Xdoclint فعال است. آن را با گزینه -Xdoclint:none غیرفعال کنید.
گزینه‌های زیر مواردی را که گزینه -Xdoclint گزارش می‌دهد تغییر می‌دهند:
- •
- -Xdoclint none: گزینه -Xdoclint را غیرفعال می‌کند
- •
- -Xdoclint group: بررسی‌های group را فعال می‌کند
- •
- -Xdoclint all: تمام گروه‌های بررسی را فعال می‌کند
- •
- -Xdoclint all,-group: تمام بررسی‌ها به جز بررسی‌های group را فعال می‌کند
متغیر group یکی از مقادیر زیر را دارد:
- •
- accessibility: مسائلی را که باید توسط یک بررسی‌کننده دسترس‌پذیری شناسایی شوند بررسی می‌کند (برای مثال، هیچ ویژگی caption یا summary در تگ <table> مشخص نشده باشد).
- •
- html: مسائل سطح بالای HTML را شناسایی می‌کند، مانند قرار دادن عناصر بلوکی درون عناصر درون‌خطی، یا نبستن عناصری که به تگ پایانی نیاز دارند. قوانین از مشخصات HTML 4 [https://www.w3.org/TR/html4] یا مشخصات HTML 5 [http://www.w3.org/TR/2014/REC-html5-20141028] بر اساس تولید خروجی html داکلت استانداردِ انتخاب‌شده مشتق شده‌اند. این نوع بررسی ابزار javadoc را قادر می‌سازد تا مشکلات HTML را که برخی مرورگرها ممکن است به درستی تفسیر نکنند شناسایی کند.
- •
- missing: کامنت‌ها یا تگ‌های مستندسازی گم‌شده را بررسی می‌کند (برای مثال، یک کامنت یا کلاس گم‌شده، یا یک تگ @return گم‌شده یا تگ مشابه روی یک متد).
- •
- reference: مشکلات مربوط به ارجاعات به عناصر Java API از تگ‌های کامنت مستندسازی را بررسی می‌کند (برای مثال، موردی که در @see یافت نشد، یا نام نامناسب بعد از @param).
- •
- syntax: مشکلات سطح پایین مانند براکت‌های زاویه‌دار اسکیپ‌نشده (< و >) و آمپرسندها (&) و تگ‌های نامعتبر کامنت مستندسازی را بررسی می‌کند.
می‌توانید گزینه -Xdoclint را چندین بار مشخص کنید تا بررسی خطاها و هشدارها در دسته‌های مختلف فعال شود. به عنوان روش دیگر، می‌توانید چندین دسته خطا و هشدار را با استفاده از گزینه‌های قبلی مشخص کنید. برای مثال، از هر یک از دستورات زیر برای بررسی مشکلات HTML، نحو و دسترس‌پذیری در فایل filename استفاده کنید.
javadoc -Xdoclint:html -Xdoclint:syntax -Xdoclint:accessibility filename
javadoc -Xdoclint:html,syntax,accessibility filename
نکته:
ابزار javadoc کامل بودن این بررسی‌ها را تضمین نمی‌کند. به‌ویژه، این یک بررسی‌کننده کامل انطباق HTML نیست. هدف از گزینه -Xdoclint این است که ابزار javadoc را قادر سازد تا اکثریت خطاهای رایج را گزارش کند.
ابزار javadoc تلاشی برای تصحیح ورودی نامعتبر نمی‌کند، فقط آن را گزارش می‌دهد.
- -Xdoclint/package:[-]packages
- بررسی‌ها را در بسته‌های خاص فعال یا غیرفعال می‌کند. packages یک فهرست جداشده با کاما از مشخص‌کننده‌های بسته است. یک مشخص‌کننده بسته یا یک نام واجد شرایط از یک بسته است یا یک پیشوند نام بسته که به دنبال آن * آمده باشد، که به تمام زیربسته‌های بسته داده‌شده گسترش می‌یابد. مشخص‌کننده بسته را با - پیشوند دهید تا بررسی‌ها برای بسته‌های مشخص‌شده غیرفعال شوند.
- -Xdocrootparent url
- تمام موارد @docRoot که بعد از آن‌ها /.. در کامنت‌های Javadoc آمده است را با url جایگزین می‌کند.
| 2021 | JDK 17 |