Doxygen for Mac - Download

إذن أنت مطور، أليس كذلك؟ لديك قاعدة بيانات قوية هذه، لكن لن يقرأها أحد إلا إذا قمت بكتابة الوثائق. وكان الله في عونك إذا كان عليك أن تفعل ذلك باليد. وهنا يأتي دور Doxygen. لقد استخدمته في عدد قليل من المشاريع الجانبية، معظمها في Python وC++، وبصراحة، لقد وفر لي ساعات. فهو يقوم فقط بمسح التعليمات البرمجية الخاصة بك، وسحب التعليقات، وإنشاء صفحات HTML نظيفة مع قوائم الوظائف، والتسلسلات الهرمية للفئات، وحتى الرسوم البيانية للاتصال. لا يوجد سحر، لكنه يعمل.

الاشياء الجيدة

ما لفت انتباهي حقًا هو مدى سرعة تحويل تعليقاتي الفوضوية إلى شيء قابل للاستخدام فعليًا. مثلًا، كان لدي ملف رأسي يحتوي على 15 وظيفة، وكلها موثقة بها///أو/** */. قم بتشغيل Doxygen، boom - موقع HTML قابل للتصفح الفوري. ليست هناك حاجة للنسخ واللصق في موقع wiki أو الاحتفاظ بملف تخفيض السعر منفصل. يبدو الإخراج لائقًا أيضًا - ليس مبهرجًا ولكنه عملي. إذا كنت تعمل ضمن فريق، فالأمر أسهل بكثير من محاولة شرح ما تفعله كل وظيفة عبر رسائل Slack. كما أنه يدعم لغات متعددة، لذا فهو لا يقتصر على C++ فقط مثل بعض الأدوات التي رأيتها.

غير جيد

نعم، إنه مجاني - وهو أمر رائع - ولكن منحنى التعلم ليس صفرًا. يمكن أن يكون ملف التكوين (Doxyfile) مرهقًا في البداية. يجب عليك تعديل المسارات، واختيار تنسيقات الإخراج، وإعداد رؤية الرمز... لقد استغرق الأمر مني محاولتين قبل أن أتمكن من تشغيل إخراج PDF. وليس هناك واجهة المستخدم الرسومية. مجرد سطر الأوامر. لذا، إذا كنت شخصًا يكره المحطات الطرفية، فقد يبدو هذا أمرًا صعبًا. كما أن المستندات التي تم إنشاؤها تكون دقيقة فقط إذا كانت تعليقاتك كذلك. إذا تخطيت توثيق إحدى الوظائف، فلن يخمن Doxygen ما يفعله. ولا تتكامل الأداة مع IDEs بشكل جيد - يجب عليك تشغيلها يدويًا أو كتابتها. ليست رهيبة، ولكن ليس على نحو سلس سواء.

خلاصة القول

إذا كنت تكتب تعليمات برمجية سيلمسها الآخرون - سواء كان مشروعًا شخصيًا أو مستودعًا جماعيًا - فإن Doxygen لنظام التشغيل Mac - التنزيل لنظام التشغيل Windows يستحق التنزيل. إنه مجاني، ويعمل، ويختصر السؤال "ما الذي تفعله هذه الوظيفة؟" فوضى. إنها ليست الأداة الأكثر بهرجة، ولكنها تنجز المهمة دون أي ضجة. قم بتخطيها فقط إذا كنت تكتب نصوصًا برمجية غير ضرورية أو تكره أدوات CLI. خلاف ذلك، إعطائها فرصة. سوف تشكر نفسك لاحقا.