ford

فورد

هذا هو مولد توثيق تلقائي لبرامج Fortran الحديثة. فورد تعني فورتران مستند. كما تعلم ، يشير "إلى فورد" إلى عبور نهر (أو أي جسم ماء آخر). لا يشير ، في هذا السياق ، إلى أي شركة أو فرد مرتبط بالسيارات.

كُتب فورد بسبب تعامل Doxygen السيئ مع Fortran وعدم وجود بدائل مماثلة. لا يمكن لـ Robodoc بالفعل استخراج أي معلومات من الكود المصدري وعن أي برنامج توثيق تلقائي آخر وجدته كان إما ملكية أو لم يعمل بشكل جيد للغاية بالنسبة لـ Fortran ، أو كان محدودًا من حيث كيفية إنتاجه. F90DOC جيدة جدًا وتمكنت من تعديلها حتى تتمكن من التعامل مع معظم Fortran 2003 ، لكنها تنتج وثائق قبيحة إلى حد ما ، ولا يمكن أن توفر العديد من الروابط بين أجزاء مختلفة من الوثائق كما أود ، وهي مكتوب في Perl (والتي لست على دراية بها والتي تفتقر إلى نوع المكتبات الموجودة في بيثون لإنتاج محتوى HTML).

الهدف من فورد هو أن تكون قادرًا على إنتاج وثائق موثوقة لبرنامج Fortran الحديث والذي يعد مفيدًا وممتعًا للنظر فيه. يجب أن يكون الوثائق سهلة الكتابة وغير الاغتصاب داخل الكود. على الرغم من أنها لن تكون غنية بالميزات مثل Doxygen ، نأمل أن تتمكن فورد من توفير بديل جيد لتوثيق مشاريع Fortran.

القدرات

تشمل الميزات الحالية:

• القدرة على استخراج المعلومات حول المتغيرات والإجراءات ووسائط الإجراءات والأنواع المشتقة والبرامج والوحدات النمطية من الكود المصدري.
• القدرة على استخراج الوثائق من التعليقات في رمز المصدر.
• دعم اللاتكس في الوثائق باستخدام Mathjax.
• وثائق قابلة للبحث ، باستخدام Lunr Search.
• وصف المؤلف ووسائل التواصل الاجتماعي (بما في ذلك github!) روابط.
• روابط لتنزيل رمز المصدر.
• روابط للملفات الفردية ، سواء في شكلها الخام أو في HTML مع تمييز بناء الجملة.
• استخدام Markdown إلى وثائق مجموعة.
• الروابط بين الأجزاء ذات الصلة من البرنامج.
• Bootstrap CSS للوثائق ، مما يجعلها وظيفية وجميلة.
• إعدادات قابلة للتكوين.
• القدرة على إنشاء مجموعة هرمية من الصفحات التي تحتوي على معلومات عامة ، لا ترتبط بأي جزء معين من رمز المصدر.
• اعرض إدخالًا لملفات المصدر غير الناشئة مع الوثائق على مستوى الملف والرمز المميز للبناء.

تثبيت

أبسط طريقة لتثبيت فورد هي استخدام PIP:

 pip install ford

ستقوم PIP تلقائيًا بمعالجة جميع التبعيات لك. بشكل افتراضي ، سيضع هذا ford في ~/.local/bin - قد تحتاج إلى إضافة هذا إلى PATH .

بدلاً من ذلك ، تتوفر Ford من خلال Homebrew Package Manager لـ Mac OS X. لتحديث Homebrew وتثبيت Ford ، قم بتشغيل هذه الأوامر في محطة:

 brew update
brew install FORD

إذا كنت ترغب في تثبيت أحدث فرع التطوير (Master) من Github ، فما عليك سوى إضافة العلم --HEAD : brew install --HEAD FORD

تتوفر Ford أيضًا من خلال مدير حزمة Spack عن طريق تشغيل الأمر التالي:

 spack install py-ford

الوثائق

يمكن العثور على المزيد من الوثائق الكاملة في المستندات.

رخصة

هذا البرنامج هو برنامج مجاني: يمكنك إعادة توزيعه و/أو تعديله بموجب شروط رخصة GNU العامة العامة كما تم نشرها من قبل مؤسسة البرمجيات المجانية ، إما الإصدار 3 من الترخيص ، أو (في خيارك) أي إصدار لاحق.

يتم توزيع هذا البرنامج على أمل أن يكون مفيدًا ، ولكن بدون أي محار ؛ بدون حتى الضمان الضمني للتسويق أو اللياقة لغرض معين . راجع رخصة GNU العامة لمزيد من التفاصيل.

يجب أن تكون قد تلقيت نسخة من رخصة GNU العامة العامة مع هذا البرنامج. إذا لم يكن كذلك ، راجع موقع GNU.

المستندات التي تنتجها فورد هي أعمال مشتقة مستمدة من المدخلات المستخدمة في إنتاجها ؛ لا يتأثرون بهذا الترخيص.