appledoc
2.2.1 build 1333
ملاحظة هامة: مطلوب متعاونين
appledoc هي أداة سطر أوامر تساعد مطوري Objective-C على إنشاء وثائق التعليمات البرمجية المصدر المشابهة لـ Apple من تعليقات التعليمات البرمجية المصدر المنسقة خصيصًا. لقد تم تصميمه ليأخذ تعليقات كود المصدر القابلة للقراءة قدر الإمكان للإدخال واستخدام التعليقات بالإضافة إلى كود المصدر المحيط لإنشاء وثائق جذابة بصريًا في شكل HTML بالإضافة إلى مجموعة وثائق Xcode المفهرسة والقابلة للتصفح بالكامل. على الرغم من وجود العديد من الأدوات التي يمكنها إنشاء وثائق HTML لـ Objective-C، إلا أن جميع الأدوات التي أعرفها تعجز عن تحقيق الحد الأدنى من الأهداف الموضحة أدناه.
الأهداف الرئيسية ل appledoc:
لجعل تجربتك مع appledoc سلسة قدر الإمكان، نقترح بشدة قراءة هذا المستند بالكامل بالإضافة إلى جميع الوثائق عبر الإنترنت المذكورة في قسم "استخدام appledoc" أدناه!
يُسمح باستخدام appledoc بموجب الشروط المذكورة في قسم الترخيص أسفل هذا الملف!
هل تريد أن تظل محدثًا؟ تابعونا على تويتر - @gentlebytes.
الطريقة الموصى بها هي استنساخ مشروع GitHub وتجميع الأداة من Xcode. نظرًا لأن استنساخ مشروع GitHub سيؤدي إلى إنشاء رابط للمستودع الرئيسي، فإنه يبسط إلى حد كبير عملية الترقية المستقبلية أيضًا. للتثبيت، اكتب ما يلي في المحطة الطرفية:
git clone git://github.com/tomaz/appledoc.git
يؤدي هذا إلى إنشاء دليل appledoc. داخل يمكنك العثور على مساحة عمل appledoc.xcworkspace Xcode؛ افتحه وقم بتجميع هدف appledoc - يجب أن يعمل هذا خارج الصندوق، ولكن يجب أن يلبي نظامك الحد الأدنى من متطلبات النظام، انظر أدناه. أنصحك بنسخ appledoc الناتج القابل للتنفيذ من دليل البناء إلى أحد الدلائل الموجودة في المسار الخاص بك ( echo $PATH ) لتسهيل الوصول إليه.
اختياري: Appledoc مستقل بذاته ويحتوي على ملفات القالب الضرورية. إذا كنت تريد تعديل هذه الإعدادات الافتراضية من الدليل الفرعي للقوالب إلى أحد المواقع المتوقعة:
يمكنك أيضًا استخدام البرنامج النصي install-appledoc.sh لإجراء التثبيت السريع. افتح Terminal وانتقل إلى دليل appledoc. اكتب الأمر التالي:
sudo sh install-appledoc.sh (if you need templates add '-t default')
يقوم بتجميع appledoc وتثبيت الملف الثنائي الخاص به على /usr/local/bin والقوالب (إذا أراد ذلك) إلى ~/.appledoc افتراضيًا. يمكنك تجاوز هذه الدلائل بخيارات -b و -t على التوالي. على سبيل المثال:
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application Support/appledoc
بدلا من ذلك مع البيرة المنزلية:
brew install appledoc
لا يقوم Homebrew بتثبيت القوالب بشكل افتراضي.
استخدم appledoc --help للاطلاع على قائمة بجميع مفاتيح تبديل سطر الأوامر. اقرأ المزيد عن appledoc على موقع appledoc. اقرأ أيضًا صفحات الويكي للاطلاع على المزيد من المقالات المتعمقة.
استخدم مجموعة appledoc Google كمنتدى للأسئلة المتعلقة بالاستخدام أو الأسئلة العامة الأخرى.
استخدم صفحة مشكلات appledoc لإرسال طلبات الأخطاء والميزات. قبل إرسال مشكلات جديدة، تحقق من المنتديات لمعرفة ما إذا تم الرد على سؤالك هناك - ما لم تتمكن من تأكيد مشكلتك كطلب ميزة جديدة أو خطأ، يجب أن تبدأ في المنتدى للحفاظ على مشكلات GitHub نظيفة. اقرأ أيضًا الإصدارات لمعرفة ما إذا كانت المشكلة موجودة بالفعل وقم بالتصويت عليها أو إضافة تعليق (لا تنس الإصدارات المغلقة).
للبقاء على اطلاع، ما عليك سوى الانتقال إلى Terminal وإدخال القرص المضغوط في دليل appledoc، وإصدار git pull وإعادة ترجمة appledoc.xcodeproj. لا تنس الكتابة فوق الملف القابل للتنفيذ appledoc الذي نسخته إلى $PATH :)
إذا كنت تريد أيضًا تجميع هدف AppledocTests (اختبارات الوحدة) وتشغيله، فأنت بحاجة إلى نسخ جميع الأطر المشار إليها ضمن مجموعة Libraries & Frameworks إلى دليل الأطر المشتركة قبل إنشاء هدف اختبارات الوحدة! هذا غير مطلوب لبناء أداة appledoc نفسها.
يمكنك إعداد Xcode لأتمتة إنشاء مستندات appledoc. تعرف على كيفية استخدام برنامج التشغيل ومراحل بناء مشروعك.
تتوفر الوثائق ومجموعات المستندات التي تم إنشاؤها مسبقًا لمعظم أطر عمل Cocoa على:
بمجرد حصولك على مجموعة المستندات، قد ترغب في استخدامها مع متصفح الوثائق:
هل لديك مشاكل؟ هذا ما يمكنك فعله لاستكشاف الأخطاء وإصلاحها:
git pull وتشغيله باستخدام الإصدار الأحدث مرة أخرى.--verbose . المستوى الافتراضي هو 2، ولكن يمكنك زيادة الإسهاب تدريجيًا حتى 6 مع كل مستوى مما يوفر لك معلومات أكثر تفصيلاً. وبما أن هذا سيوفر لك الكثير من المعلومات، فقد ترغب في التركيز فقط على مجموعة محددة من ملفات المصدر التي تواجه مشكلة فيها. لاحظ أن زيادة الإسهاب ستؤدي إلى أداء أبطأ لذا لا يوصى باستخدام مستويات أعلى من 4 للاستخدام اليومي.إذا كنت ترغب في المساهمة، راجع ملف ملاحظات المطور للحصول على نظرة عامة قصيرة حول كيفية عمل appledoc داخليًا.
تم ترخيص appledoc بترخيص BSD المعدل. بلغة واضحة: يُسمح لك بفعل ما يحلو لك باستخدام الكود وتعديله وإعادة توزيعه وتضمينه في منتجاتك (مجانية أو تجارية)، ولكن يجب عليك تضمين حقوق الطبع والنشر وشروط الاستخدام وإخلاء المسؤولية كما هو منصوص عليه في الترخيص، نفس الشيء الطريقة مثل أي كود آخر مرخص من BSD. يمكنك بالطبع استخدام الوثائق التي تم إنشاؤها بواسطة appledoc لمنتجاتك (المجانية أو التجارية)، ولكن يجب عليك أن تنسب appledoc إما في الوثائق نفسها أو في مكان آخر مناسب مثل موقع الويب الخاص بك.
إذا لم تتمكن لأي سبب من الأسباب من الموافقة على هذه الشروط، فاتصل بنا من خلال نموذج الاتصال الموجود على صفحتنا، وسنبذل قصارى جهدنا لمساعدتك وإيجاد حل عملي!
حقوق الطبع والنشر (ج) 2009-2011، Gentle Bytes جميع الحقوق محفوظة.
يُسمح بإعادة التوزيع والاستخدام في النماذج المصدرية والثنائية والوثائق التي تم إنشاؤها، مع أو بدون تعديل، بشرط استيفاء الشروط التالية:
يجب أن تحتفظ عمليات إعادة توزيع التعليمات البرمجية المصدر بإشعار حقوق الطبع والنشر المذكور أعلاه وقائمة الشروط هذه وإخلاء المسؤولية التالي.
يجب أن تقوم عمليات إعادة التوزيع في شكل ثنائي بإعادة إنتاج إشعار حقوق الطبع والنشر أعلاه وقائمة الشروط وإخلاء المسؤولية التالي في الوثائق و/أو المواد الأخرى المقدمة مع التوزيع.
يجب أن تتضمن عمليات إعادة توزيع الوثائق التي تم إنشاؤها بواسطة appledoc الإسناد إلى appledoc، إما في الوثائق نفسها أو في الوسائط المناسبة الأخرى.
لا يجوز استخدام اسم appledoc أو Gentle Bytes ولا أسماء المساهمين فيه لتأييد أو الترويج للمنتجات المشتقة من هذا البرنامج دون الحصول على إذن كتابي مسبق محدد.
يتم توفير هذا البرنامج من قبل أصحاب حقوق الطبع والنشر والمساهمين "كما هو" ويتم إخلاء المسؤولية عن أي ضمانات صريحة أو ضمنية، بما في ذلك، على سبيل المثال لا الحصر، الضمانات الضمنية لقابلية التسويق والملاءمة لغرض معين. لا يتحمل صاحب حقوق الطبع والنشر أو المساهمين بأي حال من الأحوال المسؤولية عن أي أضرار مباشرة أو غير مباشرة أو عرضية أو خاصة أو نموذجية أو تبعية (بما في ذلك، على سبيل المثال لا الحصر، شراء السلع أو الخدمات البديلة؛ فقدان الاستخدام، البيانات، أو الأرباح؛ أو انقطاع الأعمال) مهما كان السبب وعلى أي نظرية للمسؤولية، سواء في العقد أو المسؤولية الصارمة أو الضرر (بما في ذلك الإهمال أو غيره) الذي ينشأ بأي شكل من الأشكال عن استخدام هذا البرنامج، حتى لو تم النصح بهذا الاحتمال. من مثل هذه الأضرار.
وحدات البايت اللطيفة [email protected]
