سدوك هو تنسيق ملف يستخدم لإنشاء وعرض وثائق البرنامج. عادة ما يحتوي على تعليقات وتعليمات تصف الوظائف والفئات والأساليب في رمز البرنامج. يمكنك إنشاء ملفات سدوك لمشاريعك في لغات البرمجة المختلفة ، بما في ذلك روبي ، جافا سكريبت ، سي others وغيرها.
فتح ملفات سدوك يمكن أن يكون عملية معقدة إلى حد ما ، وخاصة إذا كنت جديدا على هذا الشكل. في هذا الدليل ، ونحن سوف اقول لكم كيفية فتح ملفات سدوك على جهاز الكمبيوتر الخاص بك مع تعليمات مفصلة ونصائح مفيدة.
لعرض ملفات سدوك ، سوف تحتاج إلى برنامج قادر على فتح وعرض محتويات هذه الملفات. هناك العديد من البرامج التي تدعم فتح وعرض ملفات سدوك ، على سبيل المثال ، سدوك عارض وساحة. يوفر كلاهما واجهة سهلة الاستخدام لعرض الوثائق ، مما يتيح لك العثور بسرعة على المعلومات التي تحتاجها والتنقل عبر رمز البرنامج.
من خلال فتح ملفات سدوك ، يمكنك الوصول إلى الوصف الكامل لمشروع البرنامج الخاص بك ، مما يجعل من السهل فهم التعليمات البرمجية وتحسين كفاءتها.
- تثبيت سدوك على جهاز كمبيوتر
- إنشاء مشروع سدوك جديد
- تهيئة بيئة للعمل مع مركز التنمية المستدامة
- إضافة وتنسيق المحتوى في سدوك
- إعداد الوثائق في لجنة التنمية المستدامة
- تصدير ونشر الوثائق إلى سدوك
- سؤال وجواب
- التي لغة البرمجة لا دعم سدوك?
- هل هناك بدائل ل سدوك?
- ما هي المعلومات التي يمكن العثور عليها في سدوك?
تثبيت سدوك على جهاز كمبيوتر
لتثبيت سدوك على جهاز الكمبيوتر الخاص بك ، سوف تحتاج إلى الأدوات التالية:
- جهاز كمبيوتر مع نظام التشغيل ويندوز ، ماك ، أو لينكس
- تثبيت روبي مع الإصدار 2.5.0 أو أعلى
- المجمعة المثبتة باستخدام الأمر
بعد التأكد من تكوين أدواتك التي تعمل معا وجاهزة ، يمكنك تثبيت سدوك باتباع الخطوات التالية:
- قم بإنشاء مجلد جديد على جهاز الكمبيوتر الخاص بك وانتقل إلى هذا المجلد باستخدام
- إنشاء جيمفيل جديد باستخدام الأمر
- افتح ملف الأحجار الكريمة في محرر نصوص وأضف السطر التالي:
- احفظ ملف جيمفيل وأغلق محرر النصوص
- تثبيت سدوك باستخدام الأمر
. سترى أن سدوك يبدأ توليد الوثائق استنادا إلى التعليقات في شفرة المصدر الخاصة بك.
قد يستغرق تثبيت سدوك على جهاز الكمبيوتر الخاص بك بعض الوقت ، اعتمادا على سرعة اتصالك بالإنترنت وأداء جهاز الكمبيوتر الخاص بك. ولكن بعد التثبيت ، سوف تكون على استعداد لاستخدام سدوك لإنشاء وثائق المهنية ومفهومة للمشاريع الخاصة بك.
إنشاء مشروع سدوك جديد
لإنشاء مشروع سدوك جديد ، سوف تحتاج إلى أداة روبي و سدوك جوهرة تثبيت.
للبدء ، افتح موجه الأوامر وقم بتشغيل الأمر التالي:
- قم بإنشاء مجلد جديد للمشروع وانتقل إليه:
- تهيئة مشروع روبي جديد:
- تثبيت جوهرة سدوك:
- إنشاء ملف تكوين للمشروع:
مشروع مكدير
مشروع سي دي
روبي الحرف الأول
جوهرة تثبيت سدوك
المس سدوك.يمل
الآن يمكنك تكوين مشروع سدوك الخاص بك في سدوك.ملف إمل وإضافة تعليقات كما شفرة المصدر.
بعد تكوين المشروع ، يمكنك إنشاء وثائق عن طريق تشغيل الأمر سدوك على سطر الأوامر:
سدوك
سيتم حفظ الوثائق التي تم إنشاؤها في مجلد المستند داخل مشروعك.
الآن يمكنك فتح الوثائق التي تم إنشاؤها في متصفح والبدء في استخدام سدوك لتوثيق المشروع الخاص بك.
مبارك! الآن أنت تعرف كيفية إنشاء مشروع سدوك جديد وتوليد وثائق لذلك.
تهيئة بيئة للعمل مع مركز التنمية المستدامة
للعمل مع سدوك ، تحتاج إلى تكوين البيئة وتثبيت المكونات اللازمة. هنا تعليمات خطوة بخطوة:
- في المحطة.
- في المحطة.
- لإنشاء جيمفيل.
- . ونتيجة لذلك ، يجب أن جيمفيل الخاص بك تبدو شيئا من هذا القبيل:
- في محطة لتثبيت كافة التبعيات ، بما في ذلك سدوك. سوف بوندلر تلقائيا تحميل وتثبيت جميع المكونات اللازمة.
| المصدر https://rubygems.org' |
| المجموعة: التنمية تفعل |
| جيم 'سدوك' |
| النهاية |
بعد الانتهاء من هذه الخطوات ، ستكون بيئتك جاهزة للعمل مع سدوك. الآن يمكنك إنشاء وتوليد وثائق للمشروع الخاص بك باستخدام سدوك.
إضافة وتنسيق المحتوى في سدوك
لإنشاء محتوى بتنسيق سدوك ، يمكنك استخدام علامات مختلفة لتنسيق النص. وهنا بعض منهم:
- علامة لإنشاء الفقرات.
- - علامة لتسليط الضوء على النص بالخط العريض.
- - علامة للنص المائل.
- - علامة لإنشاء قائمة مرتبة.
- - علامة لإنشاء قائمة غير مرتبة.
- - علامة لإنشاء عنصر قائمة.
- علامة لإنشاء جدول.
دعونا ننظر إلى مثال على استخدام هذه العلامات في سدوك:
هذا هو مثال الفقرة في سدوك.
هذا مجرد مثال صغير على كيفية استخدام العلامات المختلفة لتنسيق المحتوى في سدوك. يمكنك دمج هذه العلامات واستخدامها معا لإنشاء بنية محتوى أكثر تعقيدا.
إعداد الوثائق في لجنة التنمية المستدامة
واحدة من المهام الهامة عند إنشاء الوثائق باستخدام سدوك هو تصميمه. يجعل تصميم الوثائق عالي الجودة من السهل فهمه وتحسين الإدراك البصري للنص وزيادة سهولة قراءته.
فيما يلي بعض المبادئ الأساسية لتصميم الوثائق في سدوك:
- استخدام رؤوس من مستويات مختلفة لهيكلة محتويات الوثائق. تساعد العناوين القارئ على التنقل بسرعة وسهولة في العثور على المعلومات التي يحتاجها.
- استخدم تمييز النص ، مثل الخط المائل أو الغامق ، لإبراز النقاط المهمة والأفكار الرئيسية في الوثائق.
- لسرد عناصر مثل خطوات في تعليمات أو قائمة معلمات ، استخدم قائمة ذات تعداد نقطي باستخدام علامة
- إذا كان هناك العديد من أعمدة الوصف أو جدول بيانات في الوثائق ، فاستخدم العلامة
تصدير ونشر الوثائق إلى سدوك
هناك العديد من الأساليب والأدوات لتصدير ونشر الوثائق في شكل سدوك.
1. باستخدام سطر الأوامر:
- تثبيت روبي وروبيجيمز.
- تثبيت جوهرة سدوك باستخدام الأمر:
- قم بإنشاء دليل للتوثيق وانتقل إليه.
- إنشاء ملف تكوين ل سدوك باستخدام الأمر:
- Используйте команду для генерации документации:
جوهرة تثبيت سدوكسدوك-دمج-مسار الجذر / إلى / المصدر-مسار الإخراج / إلى / الوجهةسدوك-س مسار / إلى / الوجهة مسار / إلى / المصدر2. Использование الخليع:
- Ra راكفيل..
- Добавьте следующий код в файл:
| راكفيل |
|
|
وثيقة = سدوك:: دمج.جديد (خيارات)
دكتور.توليد
النهاية
تشغيل الأمر سدوك الخليع لتوليد الوثائق.
3. باستخدام واجهة المستخدم الرسومية:
هناك تطبيقات واجهة المستخدم الرسومية التي تسمح لك لتصدير ونشر الوثائق في شكل سدوك. أحد هذه التطبيقات هو روبيمين.