Doxygen 1.8.5

Doxygen - ابزار مستندسازی نهایی برای توسعه دهندگان

به عنوان یک توسعه دهنده، می دانید که داشتن اسناد واضح و مختصر برای کدتان چقدر مهم است. بدون مستندات مناسب، درک ساختار پایگاه کد شما ممکن است دشوار باشد و منجر به سردرگمی و خطا شود. اینجاست که Doxygen وارد می شود - ابزار قدرتمندی که می تواند مرورگرهای مستندات آنلاین و کتابچه راهنمای مرجع آفلاین را از فایل های منبع شما تولید کند.

Doxygen یک نرم افزار رایگان و متن باز است که از سال 1997 وجود داشته است. این نرم افزار به دلیل استفاده آسان، انعطاف پذیری و ویژگی های قدرتمند به یکی از محبوب ترین ابزارهای مستندسازی در بین توسعه دهندگان تبدیل شده است. با Doxygen، می‌توانید به راحتی اسنادی با ظاهر حرفه‌ای برای پروژه‌های خود بدون صرف ساعت‌ها برای نوشتن آن‌ها ایجاد کنید.

یکی از ویژگی های کلیدی Doxygen توانایی آن در استخراج اسناد به طور مستقیم از فایل های منبع شما است. این بدان معنی است که شما مجبور نیستید فایل های مستند جداگانه بنویسید یا آنها را جدا از پایگاه کد خود نگهداری کنید. در عوض، شما به سادگی با استفاده از تگ های ویژه ای که داکسیژن تشخیص می دهد، نظرات را به فایل های منبع خود اضافه می کنید.

این تگ ها به شما اجازه می دهد تا جنبه های مختلف کد خود مانند توابع، کلاس ها، متغیرها و موارد دیگر را مستند کنید. همچنین می‌توانید اطلاعاتی در مورد پارامترها، مقادیر بازگشتی، استثناهای پرتاب شده توسط توابع یا روش‌ها و غیره اضافه کنید تا درک نحوه عملکرد کد برای توسعه‌دهندگان دیگر (یا حتی خودتان) آسان‌تر شود.

هنگامی که این نظرات را در سراسر فایل های منبع خود اضافه کردید (که ممکن است در ابتدا خسته کننده به نظر برسد، اما به مرور نتیجه می دهد)، اجرای Doxygen یک رابط مرورگر مبتنی بر HTML با تمام اطلاعات مرتبط در مورد هر تابع/کلاس/متغیر/غیره ایجاد می کند. ، از جمله هر نمودار مرتبط مانند درختان ارثی یا نمودارهای همکاری.

اما اگر برخی از قسمت های کد مستند نباشند چه؟ مشکلی نیست! با گزینه‌های پیکربندی Doxygen (که گسترده هستند)، می‌توانید به آن بگویید که به هر حال کدام بخش‌های غیرمستند باید در خروجی تولید شده گنجانده شوند - به این ترتیب حتی اگر شکاف‌هایی در دانش در مورد مناطق خاصی وجود داشته باشد که در هنگام مرور به طور کامل از دید آن‌ها غافل نخواهند شد. اسناد تولید شده بعدا در پایین خط!

یکی دیگر از ویژگی‌های عالی Doxygen پشتیبانی آن از تولید خروجی در فرمت‌های مختلف مانند RTF (MS-Word)، PostScript/PDFs/پی‌دی‌اف‌های پیوندی/صفحه‌های man HTML/Unix فشرده و غیره است. در اینجا آنها به احتمال زیاد چیزی مناسب پیدا خواهند کرد!

نمودارهای وابستگی دربرگیری که قبلاً ذکر شد یکی دیگر از ویژگی‌های عالی است: این نمودارها نشان می‌دهند که چگونه عناصر مختلف در یک پروژه از نظر بصری با هم مرتبط می‌شوند، بنابراین کاربران به سرعت ایده‌ای پیدا می‌کنند که در آن همه چیز در جای خود قرار می‌گیرد، بدون اینکه از قبل هر خطی را خودشان مطالعه کنند. این باعث صرفه جویی در زمان می شود، به ویژه هنگام کار با پروژه های بزرگ که شامل بسیاری از اجزای وابسته به هم هستند.

نمودارهای وراثت با نشان دادن روابط بین کلاس‌ها/رابط‌ها/غیره مزایای مشابهی را ارائه می‌کنند، در حالی که نمودارهای همکاری تعاملات بین اشیاء مختلف را در همان کلاس‌ها/رابط‌ها/و غیره نشان می‌دهند. /files/folders/etc..

به طور کلی، اگر به دنبال ابزاری با کاربری آسان و در عین حال قدرتمند هستید که بتواند اسناد با کیفیت بالا را به سرعت و کارآمد تولید کند، به شدت توصیه می کنیم که DoxyGen را امتحان کنید!