نرم افزار Doxygen یک ابزار تولید اسناد قدرتمند است که می‌تواند برای ایجاد اسناد برای C++، Java، Python و سایر زبان‌های برنامه‌نویسی استفاده شود. این نرمافزار ویژگی‌های مختلفی را برای کمک به شما در مستندسازی کد ارائه می‌دهد، ازجمله توانایی تولید HTML، PDF و فرمت‌های دیگر از جمله توانایی های این نرم افزار است.
در این آموزش، فرآیند استفاده از Doxygen برای تولید مستندات برای یک پروژه C++ را مرور خواهیم کرد.
مرحله 1: Doxygen را نصب کنید
اولین قدم این است که Doxygen را روی سیستم خود نصب کنید. می‌توانید آخرین نسخه Doxygen را از وب‌سایت رسمی (http://www.doxygen.nl/) دانلود کنید. پس از دانلود بسته، می‌توانید با استفاده از مدیریت بسته سیستم خود یا با دنبال کردن دستورالعمل‌های ارائه‌شده دربسته، آن را نصب کنید.
مرحله 2: Doxygen را پیکربندی کنید
قبل از اینکه بتوانید مستندات را با استفاده از Doxygen ایجاد کنید، باید یک فایل پیکربندی ایجاد کنید که گزینه‌هایی را که می‌خواهید استفاده کنید را مشخص کنید. Doxygen یک ابزار پیکربندی گرافیکی به نام Doxywizard ارائه می‌دهد که ایجاد و تغییر فایل‌های پیکربندی را آسان می‌کند. برای باز کردن Doxywizard کافی است دستور زیر را در ترمینال خود اجرا کنید:
doxywizard
با این کار جادوگر پیکربندی Doxygen باز می‌شود، جایی که می‌توانید گزینه‌های مختلفی را برای مستندات پروژه خودتنظیم کنید.
مرحله 3: تنظیمات پروژه را پیکربندی کنید
صفحه اول جادوگر Doxygen به شما امکان می‌دهد تنظیمات پروژه خود را مشخص کنید. در اینجا، می‌توانید نام پروژه، شماره نسخه و سایر اطلاعاتی که در مستندات تولیدشده ظاهر می‌شود را تنظیم کنید. همچنین می‌توانید دایرکتوری کد منبع و دایرکتوری خروجی را که اسناد تولیدشده در آن ذخیره می‌شود را مشخص کنید.
مرحله 4: فیلترهای ورودی را پیکربندی کنید
صفحه فیلترهای ورودی جادوگر به شما امکان می‌دهد پسوندهای فایلی را که باید در اسناد گنجانده شود را مشخص کنید. به‌طور پیش‌فرض، Doxygen همه فایل‌های با پسوندهای.c،.cc،.cxx،.cpp،.h،.hh، hxx. و hpp. را شامل می‌شود. اگر پروژه شما از پسوندهای فایل اضافی استفاده می‌کند، می‌توانید آن‌ها را در اینجا اضافه کنید.
مرحله 5: فرمت‌های خروجی را پیکربندی کنید
صفحه فرمت‌های خروجی ویزارد به شما امکان می‌دهد فرمت‌هایی را که می‌خواهید مستندات را در آن‌ها تولید کنید، مشخص کنید. Doxygen از انواع فرمت‌های خروجی ازجمله HTML، PDF، LaTeX و RTF پشتیبانی می‌کند. بسته به نیاز خود می‌توانید یک یا چند فرمت خروجی را انتخاب کنید.
مرحله 6: Layout و Stylesheets را پیکربندی کنید
صفحه Layout and Stylesheets جادوگر به شما این امکان را می‌دهد که گزینه‌های طرح‌بندی و استایل را برای اسناد تولیدشده مشخص کنید. در اینجا، می‌توانید فایل‌های سر صفحه و پاورقی را که باید در مستندات گنجانده شوند و همچنین شیوه‌نامه‌ای را که باید برای استایل دادن به خروجی HTML استفاده شود، مشخص کنید.
مرحله 7: تنظیمات اضافی را پیکربندی کنید
صفحه تنظیمات اضافی ویزارد به شما امکان می‌دهد گزینه‌های اضافی را برای فرآیند تولید اسناد مشخص کنید. در اینجا می‌توانید گزینه‌هایی را برای پیش پردازنده تنظیم کنید، مسیرها و سایر گزینه‌های پیشرفته را اضافه کنید.
مرحله 8: مستندات را ایجاد کنید
هنگامی‌که تمام تنظیمات را پیکربندی کردید، می‌توانید با کلیک بر روی دکمه Run در پنجره Doxywizard اسناد را ایجاد کنید. Doxygen شروع به پردازش فایل‌های منبع پروژه شما می‌کند و مستندات را در فهرست خروجی که قبلاً مشخص کرده‌اید ایجاد می‌کند.
مرحله 9: مستندات تولیدشده را مشاهده کنید
می‌توانید با باز کردن فایل index.html در فهرست خروجی با مرورگر وب خود، مستندات ایجادشده را مشاهده کنید. مستندات حاوی اطلاعاتی در مورد کلاس‌ها، توابع و سایر عناصر کد پروژه شما و همچنین نظراتی است که با استفاده از نحو اسناد Doxygen اضافه کرده‌اید.
به‌طورکلی، Doxygen ابزار قدرتمندی است که می‌تواند به شما کمک کند با کمترین تلاش، اسناد باکیفیت بالا برای پروژه‌های ++C خود ایجاد کنید. با دنبال کردن مراحل ذکرشده در این آموزش، می‌توانید به‌سرعت با Doxygen شروع کنید و شروع به تولید اسناد حرفه‌ای برای کد خود کنید.
را روی سیستم خود نصب کنید. می‌توانید آخرین نسخه Doxygen را از وب‌سایت رسمی (http://www.doxygen.nl/) دانلود کنید. پس از دانلود بسته، می‌توانید با استفاده از مدیریت بسته سیستم خود یا با دنبال کردن دستورالعمل‌های ارائه‌شده دربسته، آن را نصب کنید.
مرحله 2: Doxygen را پیکربندی کنید
قبل از اینکه بتوانید مستندات را با استفاده از Doxygen ایجاد کنید، باید یک فایل پیکربندی ایجاد کنید که گزینه‌هایی را که می‌خواهید استفاده کنید را مشخص کنید. Doxygen یک ابزار پیکربندی گرافیکی به نام Doxywizard ارائه می‌دهد که ایجاد و تغییر فایل‌های پیکربندی را آسان می‌کند. برای باز کردن Doxywizard کافی است دستور زیر را در ترمینال خود اجرا کنید:
doxywizard
با این کار جادوگر پیکربندی Doxygen باز می‌شود، جایی که می‌توانید گزینه‌های مختلفی را برای مستندات پروژه خودتنظیم کنید.
مرحله 3: تنظیمات پروژه را پیکربندی کنید
صفحه اول جادوگر Doxygen به شما امکان می‌دهد تنظیمات پروژه خود را مشخص کنید. در اینجا، می‌توانید نام پروژه، شماره نسخه و سایر اطلاعاتی که در مستندات تولیدشده ظاهر می‌شود را تنظیم کنید. همچنین می‌توانید دایرکتوری کد منبع و دایرکتوری خروجی را که اسناد تولیدشده در آن ذخیره می‌شود را مشخص کنید.
مرحله 4: فیلترهای ورودی را پیکربندی کنید
صفحه فیلترهای ورودی جادوگر به شما امکان می‌دهد پسوندهای فایلی را که باید در اسناد گنجانده شود را مشخص کنید. به‌طور پیش‌فرض، Doxygen همه فایل‌های با پسوندهای.c،.cc،.cxx،.cpp،.h،.hh، hxx. و hpp. را شامل می‌شود. اگر پروژه شما از پسوندهای فایل اضافی استفاده می‌کند، می‌توانید آن‌ها را در اینجا اضافه کنید.
مرحله 5: فرمت‌های خروجی را پیکربندی کنید
صفحه فرمت‌های خروجی ویزارد به شما امکان می‌دهد فرمت‌هایی را که می‌خواهید مستندات را در آن‌ها تولید کنید، مشخص کنید. Doxygen از انواع فرمت‌های خروجی ازجمله HTML، PDF، LaTeX و RTF پشتیبانی می‌کند. بسته به نیاز خود می‌توانید یک یا چند فرمت خروجی را انتخاب کنید.
مرحله 6: Layout و Stylesheets را پیکربندی کنید
صفحه Layout and Stylesheets جادوگر به شما این امکان را می‌دهد که گزینه‌های طرح‌بندی و استایل را برای اسناد تولیدشده مشخص کنید. در اینجا، می‌توانید فایل‌های سر صفحه و پاورقی را که باید در مستندات گنجانده شوند و همچنین شیوه‌نامه‌ای را که باید برای استایل دادن به خروجی HTML استفاده شود، مشخص کنید.
مرحله 7: تنظیمات اضافی را پیکربندی کنید
صفحه تنظیمات اضافی ویزارد به شما امکان می‌دهد گزینه‌های اضافی را برای فرآیند تولید اسناد مشخص کنید. در اینجا می‌توانید گزینه‌هایی را برای پیش پردازنده تنظیم کنید، مسیرها و سایر گزینه‌های پیشرفته را اضافه کنید.
مرحله 8: مستندات را ایجاد کنید
هنگامی‌که تمام تنظیمات را پیکربندی کردید، می‌توانید با کلیک بر روی دکمه Run در پنجره Doxywizard اسناد را ایجاد کنید. Doxygen شروع به پردازش فایل‌های منبع پروژه شما می‌کند و مستندات را در فهرست خروجی که قبلاً مشخص کرده‌اید ایجاد می‌کند.
مرحله 9: مستندات تولیدشده را مشاهده کنید
می‌توانید با باز کردن فایل index.html در فهرست خروجی با مرورگر وب خود، مستندات ایجادشده را مشاهده کنید. مستندات حاوی اطلاعاتی در مورد کلاس‌ها، توابع و سایر عناصر کد پروژه شما و همچنین نظراتی است که با استفاده از نحو اسناد Doxygen اضافه کرده‌اید.
به‌طورکلی، Doxygen ابزار قدرتمندی است که می‌تواند به شما کمک کند با کمترین تلاش، اسناد باکیفیت بالا برای پروژه‌های ++C خود ایجاد کنید. با دنبال کردن مراحل ذکرشده در این آموزش، می‌توانید به‌سرعت با Doxygen شروع به تولید اسناد حرفه‌ای برای کد خود کنید.
