داکیومنت کردن با کامنت

سلام
خیلی وقت پیش یه پروژه دیدم که به یه فرمت خاص بالای توابعش کامنت گذاشته شده بود بعد همون کامنت ها تبدیل به HTML شده بود و به شکل داکیومنت در اومده بود
میدونید باید از چه ابزاری برای این کار استفاده کنم؟
فعلا میخوام برای یه پروژه که با c++ نوشته شده این کار رو انجام بدم ولی خیلی خوب میشه اگه مستقل از زبانی که پروژه نوشته شده باشه و مثلا بعدا بتونم توی یه پروژه پایتون هم ازش استفاده کنم

چیزی رو نمیشناسم که مستقل از زبان باشه.
نمونه‌هایی که دیدم مربوط به project manager بودن. مثلا یه پلاگین که به leiningen اضافه میشه برای ساخت داکیومنت اتوماتیک در پروژه‌های clojure.
البته الآن که سرچ کردم دیدم به صورت stand-alone هم میشه ازش استفاده کرد ولی به هر حال اینکه شما میگید «متسقل از زبان» بعید میدونم وجود داشته باشه.

1 Like

یه سری از این ابزار ها از چند زبان پشتی بانی می کنن اما چیزی رو نمی شناسم که از همه چی پشتیبانی کنه. برای شروع می تونی به sphinx و doxygen نگاه بندازی. مطمئنم ابزار بهتر هم هست

3 Likes

تا اونجایی که من اطلاع دارم اکثرن اینجوریه که
واسه php از phpdoc
واسه جاوا از javadoc
واسه c از doxygen
استفاده میکنن

2 Likes

سلام
ممنون
من doxygen رو قبلا هم دیده بودم و الآن sphinx رو هم دیدم
یکمی با قالب html ای که در نهایت تحویل میدن مشکل دارم
مثلا mkdocs خیلی به نظرم خوبه ولی متاسفانه قابلیتی که من میخوام رو نداره
در کل آیا این روش برای داکیومنت کردن رو پیشنهاد میکنید؟

1 Like

کلا دوتا مدل مستندات هست. APIdoc و guides. اینی که شما می خوای انجام بدی APIdoc هست که خیلی شخصا می پسندم اما guides هم خیلی مهمه که داشته باشین

2 Likes