أفضل بناء جملة Wiki للوثائق في رموز الرموز وملفات Readme Project

Question

هل هناك أي بناء جملة Wiki مثل RDoc، والتخفيض، ... الموصى بها في عالم روبي؟ أنا أكتب في بعض الأحيان فتح شفرة المصدر وليس لديك غراء بناء الجملة الذي يجب استخدامه في مستندات التعليمات البرمجية وفي ملفات README. ما هو مفيد لي ولماذا تستخدمه.

Answer 1

RDOC هي أداة الوثائق الافتراضية. هو بناء جملة RDOC هو الافتراضي المسموح به داخل ملفات الروبي والمكتبات.

قد تجد texttile أو علامة تجارية تستخدم خارج فئات روبي لملفات نصية مثل README أو ملفات التغييرات. ولكن هذا ليس Sintax القياسي لذلك ستحتاج إلى طريقة لإخبار المحلل بمحلل بناء جملة يتم كتابة الملف معه، وعادة ما يكون ملحق الملفات.

جيثب، على سبيل المثال، يتبع هذا القنب بالضبط. ما لم يتم تحديد امتداد .textile أو .markdown، يتم تحليل الملف كإعادة.

• http://github.com/weppos/whois. (.rdoc == RDOC)
• http://github.com/rainails/rails/tree/master/railties/ (لا تمديد == RDoc، ولكن ليس ل Github)
• http://github.com/technoweenie/restful-Authentication/blob/master/readme.textile. (.textile == النسيج)

تذكر: AFAIK، يتم دائما تحليل الوثائق المضمنة كما RDoc.

Answer 2

على GitHub، يستخدم الناس معظمهم من RDoc أو النسيج كنسيق لملفات README الخاصة بهم. يعد RDOC أيضا مفيدا جدا ل API - توثيق التعليمات البرمجية الخاصة بك، حيث يدمج بناء الجملة لطيفة حقا في التعليمات البرمجية وممتعة القراءة.