cxref - عبر الإنترنت في السحابة

برنامج:

اسم

cxref - أداة التوثيق والمراجع التبادلية.

موجز

cxref اسم الملف [ اسم الملف] [-Oاسم] [-نbasename] [-رbasename] [-كل التعليقات]
[-بدون تعليقات] [-التعليقات الحرفية] [-كتلة-تعليقات]
[-xref [-all] [- ملف] [- func] [- var] [- type]] [-حذر [-جميع] [- تعليق] [- xref]]
[-الفهرس [-جميع] [- ملف] [- func] [- var] [- type]] [-الخام] [-لاتكس] [-html [-src]] [-رتف] [-sgml]
[-أنااسم] [-دحدد] [-Uحدد] [-حزب الشعب الكمبودي cpp_program] [- cpp_args cpp_args]

cxref اسم الملف [ اسم الملف] -حذف [-Oاسم] [-نbasename] [-رbasename]

الوصف

برنامج يمكنه تلقائيًا إنشاء وثائق ومراجع مرجعية لـ C
برنامج.

الإدخال هو أي برنامج C مع التعليقات المناسبة والمخرج هو LaTeX أو HTML أو RTF أو
ملفات SGML.

OPTIONS

اسم الملف
اسم الملف المراد توثيقه ، يمكن توثيق أي عدد من الملفات في وقت واحد.

-حذف
يجب حذف الملفات المسماة من دليل الإخراج وإدخالاتها بتنسيق
يجب إزالة قاعدة البيانات المرجعية وملفات الإخراج الرئيسية.

-اسم
اسم الدليل المراد استخدامه لملفات اللاتكس الناتجة وموقع ملف
عبر الملفات المرجعية التي تم إنشاؤها.

-Nbasename
الاسم المراد استخدامه للجزء الأول من الإخراج والملفات المرجعية التبادلية بدلاً من ذلك
من cxref ، تظل امتدادات الملفات كما هي.

-اسم الاسم
عندما تكون الملفات المصدر في أكثر من دليل ، قم بتعيين اسم الدليل على اسم
الدليل الجذر لشجرة المصدر (استخدم المسار النسبي إذا كان أسهل ، على سبيل المثال "-R ../ ..').
سيؤدي هذا بعد ذلك إلى تشغيل cxref من الدليل الجذر هذا ويجب أن يكون "-Odirname"
نسبة إلى هذا الدليل.

-كل التعليقات
في حال كنت تعتقد أن التعليقات الموجودة قد تعمل ، (انظر أعلاه للحصول على الوصف
من التعليقات الخاصة). [خطر! يمكن أن ينتج عن هذا الخيار نتائج غريبة.]

-بدون تعليقات
يتجاهل كل التعليقات ، يكون مفيدًا إذا كنت تريد المراجع التبادلية فقط وليس
كابل بيانات.

تعليقات حرفية
عندما يتم تنسيق التعليقات الموجودة في الكود بأسلوب محدد مسبقًا
التي تريد الاحتفاظ بها في الإخراج ، فإن هذا الخيار سيجبرهم على عدم القيام بذلك
مهيأ. [ملاحظة ، هذا مخصص لتعليقات الملفات والوظائف فقط.]

-كتلة التعليقات
عندما يتم تنسيق التعليقات في البرنامج بأسلوب "الكتلة" (مع بادئة
"*" في كل سطر) ، سيزيل هذا الخيار هذا الحرف من ملف
انتاج. [يعمل مع "*" ، "+" ، "|" أو ":" في كل سطر.]

-xref أنتج معلومات مرجعية متصالبة (انظر أدناه).
- جميع المراجع المتصالبة.
- ملف إشارات مرجعية للملفات.
-func المراجع التبادلية للوظائف.
-تباين المراجع المتصالبة للمتغيرات.
- نوع المراجع المتصالبة للأنواع.

-حذر إنتاج تحذيرات ، يجب أن تكون الخيارات متسلسلة معًا:
- جميع التحذيرات.
-التعليق تحذير من التعليقات المفقودة.
-xref تحذير من فقدان المراجع المتصالبة.

-فهرس أنتج فهرسًا مرجعيًا ، يجب أن تكون الخيارات متسلسلة معًا:
- جميع الفهارس.
-ملف فهرس الملفات.
-فهرس الوظائف.
- فهرس المتغيرات.
- نوع فهرس الأنواع.

-الخام أنتج شكلاً خامًا من المخرجات ، ليس مفيدًا حقًا إلا مع-warn.

-لاتكس قم بإنشاء ملف LaTeX لتوثيق كل ملف من الملفات المصدر وأيضًا ملف إضافي
يتضمن كل من هذه الملفات.

-لغة البرمجة قم بإنشاء ملف HTML 4.01 لتوثيق كل من الملفات المصدر وملف رئيسي
مرجع كل من هذه الملفات.

-html-src
قم بإنتاج مخرجات HTML وإصدار HTML من الملف المصدر مع روابط بداخله.

-rtf قم بإنشاء ملف Rich Text Format (RTF) لتوثيق الملف المصدر.

-sgml قم بإنشاء ملف SGML لتوثيق الملف المصدر. (باستخدام LinuxDoc DTD).

-اسم الاسم
خيار GCC لتحديد مسار تضمين الملفات.

-تحديد
خيار دول مجلس التعاون الخليجي لتحديد رمز ما قبل المعالج.

-تحديد
خيار GCC لإلغاء تعريف رمز ما قبل المعالج.

-CPP برنامج
اسم البرنامج الذي سيتم استخدامه بدلاً من الإعداد الافتراضي لوقت الترجمة. البرنامج
يجب أن يكون قادرًا على تنفيذ جميع الإجراءات التي يقوم بها "gcc -E -C -dD" للعمل. لو
يأخذ البرنامج الحجج ثم يجب أن يكون الأمر برمته بين علامات الاقتباس بحيث يكون
يتم تفسيره على أنه وسيطة واحدة لـ cxref.

--الأرجنتين الأرجنتين
يمكن وضع الحجج الإضافية لتمريرها إلى المعالج المسبق بعد "-"
فاصل.

C مترجم بديل cxref- سم مكعب
لتبسيط استخدام cxref على الكود المصدري الحالي ، يوجد الآن برنامج نصي شل
استدعاء مترجم C ثم استدعاء cxref لمعالجة الملف المصدر. هذا يعني أنه
يمكن استخدامها كبديل بديل لـ CC في Makefiles وما شابه ذلك.

الاستخدام: cxref-cc [خيارات cc المعتادة]

يُستخرج اسم الملف المصدر من قائمة الخيارات بالإضافة إلى "-D *" ،
أعلام "-I * 'و" -U *' وعندما يخرج المترجم C بنجاح سيتم استدعاء cxref. ال
يتم التحكم في اسم برنامج التحويل البرمجي للغة C المراد استخدامه بواسطة متغير البيئة CXREFCC ، أو إذا كان
لم يتم تعيين هذا ثم متغير بيئة CC ، أو فشل هذا فقط دول مجلس التعاون الخليجي.

يتطلب استخدام هذا البرنامج النصي استخدام ملف تكوين ".cxref" لاحتواء الخيارات
لأنه لا يوجد مكان لوضع الخيارات في سطر الأوامر لمترجم لغة سي.

سيؤدي هذا فقط إلى إسناد ترافقي وتوثيق ملفات المصدر C نظرًا لأنها الملفات الوحيدة
تلك التي تم تجميعها ، ولكنها ستتأكد من أنه يتم الرجوع إليها مع الامتداد
الخيارات الصحيحة وما إلى ذلك.

كسريف الاعداد قم بتقديم
يمكن أيضًا وضع وسيطات سطر الأوامر هذه في ملف باسم ".cxref" بدلاً من ملف
سطر الأوامر. عند تشغيل cxref ، يتم تفسير الوسائط الخاصة بالبرنامج في ملف
الترتيب التالي.

(1) تلك الموجودة في سطر الأوامر. (2) تلك الموجودة في ملف ".cxref" في الدليل الحالي.
(3) تلك الموجودة في ملف ".cxref" في جذر شجرة المصدر المحدد بواسطة "-R".

وهذا يعني أنه في شجرة مصدر متعددة الدلائل ، يمكن أن يحتوي كل دليل فرعي على ".cxref"
ملف يحتوي فقط على السطر "-R .." أو مناسب. يمكن أن يحتوي الدليل الرئيسي على ملف
يحتوي ملف ".cxref" على باقي الخيارات. هذا يزيل تماما الحاجة
للحصول على أي خيارات في سطر الأوامر بصرف النظر عن أسماء الملفات المصدر.

تنسيق ملف ".cxref" هو أي عدد من الأسطر ، يحتوي كل سطر على واحد
وسيطة سطر الأوامر (أي ما يعادل واحدة من argv). الخيارات الوحيدة التي لا يمكن أن تكون
المستخدمة هي أسماء ملفات المصدر نفسها وخيار "-حذف". الأسطر الفارغة
المتجاهلة والأسطر التي تبدأ بـ "#" هي تعليقات.

البرنامج توثيق التعليقات
يتم إنتاج وثائق البرنامج من التعليقات الموجودة في الكود
منسق بشكل مناسب. تأتي الإشارة المرجعية من الكود نفسه ولا تتطلب أي
عمل اضافي.

التعليقات الخاصة هي "/ **** **** / '(لملف) و" / * ++++ ++++ * / "(للبيانات
كائن) أي عدد من "*" أو "+" يمكن استخدامها داخل معيار "/ *" والتعليق "* /"
المحددات في التعليقات ، يتم تجاهلها.

إذا بدأ سطر التعليق بمسافة بيضاء متبوعًا بـ "+ html +" ، فإن بقية سطر التعليق
يتم تضمين السطر فقط في إخراج HTML ، ولا تتم معالجته بحيث يمكن أن يشتمل على HTML
markup ، "-html-" يعني أن باقي السطر مضمن في الكل ما عدا HTML
انتاج. الأمر نفسه ينطبق أيضًا على تنسيقات الإخراج الأخرى ، يمكن استخدام "+ لا شيء +" للأسطر
لا تظهر في أي إخراج. الاستثناء من ذلك هو أن الإخراج الخام لا يفعل أي شيء
فحص وإخراج جميع الأسطر.

في أي موقف يتبع فيه التعليق "،" ، "؛" أو ")" مفصولة بمسافات فقط و
علامات التبويب ، يتم دفع التعليق إلى قبل علامات الترقيم لتطبيقه على الكائن هناك.

يتم تنفيذ البرنامج باستخدام محلل قواعد نحوي ANSI C كامل مع بعض امتدادات دول مجلس التعاون الخليجي ،
هذا يعني أن أسلوب الكود غير مهم ، المحتوى والتعليقات فقط.

عبر الرجوع
يتم إجراء الإسناد المتقاطع للعناصر التالية

ملفات
الملفات التي تم تضمين الملف الحالي فيها
(حتى عند تضمينها عبر ملفات أخرى).

#يشمل
الملفات المضمنة في الملف الحالي.
الملفات المضمنة في هذه الملفات وما إلى ذلك.

المتغيرات
موقع تعريف المتغيرات الخارجية.
الملفات التي يمكن رؤيتها من المتغيرات العالمية.
الملفات / الوظائف التي تستخدم المتغير.

وظائف
الملف الذي تم وضع نموذج أولي فيه للوظيفة.
الوظائف التي تستدعيها الوظيفة.
الوظائف التي تستدعي الوظيفة.
الملفات والوظائف التي تشير إلى الوظيفة.
المتغيرات المستخدمة في الوظيفة.

تتم الإشارة إلى كل عنصر من هذه العناصر في الإخراج.

يستخدم الإسناد الترافقي الملفات "cxref.variable" و "cxref.function" و "cxref.include" و
"cxref.typedef" في دليل الإخراج. هذه قائمة كاملة بالوظيفة و
استخدام متغير في البرنامج ويمكن استخدامه لإنشاء تسلسل هرمي لاستدعاء الوظيفة أو
مخطط الاستخدام المتغير على سبيل المثال. هناك حاجة إلى تمريرين cxref لكل ملف ، أولهما
قم ببناء ملفات الإحالة المرجعية والثانية لاستخدامها.

(تختلف أسماء الملفات إذا تم استخدام الخيار "-N").

مطاط الناتج
ناتج LaTeX الافتراضي هو ملف لكل ملف من ملفات المصدر مع ملف إضافي واحد
"cxref.tex" الذي يتضمن كل ملف من الملفات الأخرى. هذا للسماح لـ makefile فقط
تحديث الملفات المتغيرة (على الرغم من أن المراجع قد تتطلب أن تكون جميع الملفات بتنسيق
فحص مرة أخرى). عند كتابة ملف cxref.tex ، يمكن للمستخدم تعديله ،
تتم إضافة أي ملفات جديدة تمت إضافتها في نهاية قسم التعليمات البرمجية المصدر ، ويتم إضافة باقي ملفات
الملف لم يتغير.

تتم كتابة الفهرس في ملف يسمى "cxref.apdx.tex" ويتم تحديث cxref.tex للإشارة
لذلك.

تمت كتابة ثلاثة ملفات من نمط LaTeX وهي "page.sty" و "fonts.sty" و "cxref.sty".
يقوم هؤلاء بإعداد الصفحة لاستخدام هامش أصغر وخطوط أصغر للسماح بظهور المزيد عليها
صفحة وكذلك تحديد الأوامر الجديدة لتنضيد إخراج cxref.

(أسماء الملفات "cxref.tex" و "cxref.apdx.tex" مختلفة إذا كان الخيار "-N" هو
تستخدم.)

HTML الناتج
ناتج HTML الافتراضي هو ملف لكل ملف من الملفات المصدر مع ملف إضافي واحد
"cxref.html" يتضمن كل ملف من الملفات الأخرى. هذا للسماح لـ makefile فقط
تحديث الملفات المتغيرة (على الرغم من أن المراجع قد تتطلب أن تكون جميع الملفات بتنسيق
فحص مرة أخرى). عند كتابة ملف cxref.html ، يمكن للمستخدم تعديله ،
يتم إضافة أي ملفات جديدة تمت إضافتها في النهاية قبل جدول المحتويات ، والباقي
من الملف لم يتغير.

تتم كتابة الفهرس في ملف يسمى "cxref.apdx.html" ويتم تحديث cxref.html للإشارة
لذلك.

(تختلف أسماء الملفات "cxref.html" و "cxref.apdx.html" إذا كان الخيار "-N" هو
تستخدم.)

يستخدم إخراج HTML معيار HTML 4.01 ويتم التحقق من صحة كافة الصفحات بشكل صحيح.

RTF الناتج
Rich Text Format عبارة عن تنسيق لوصف صفحة منخفض المستوى إلى حد ما ابتكرته Microsoft. هو - هي
ليس معيارًا محددًا جيدًا ويسهل فهمه مثل التنسيقات الأخرى ، ولكنه كذلك
رائج لتبادل المستندات.

يوجد ملف إخراج منفرد لكل ملف من ملفات المصدر وملف فهرس.

SGML الناتج
نظرًا لأن SGML هي لغة وصفية ، فمن الضروري تحديد عناصر التخطيط أيضًا
تقديم المعلومات. يستخدم إخراج cxref تنسيق مستند LinuxDoc وهو
مصممة للاستخدام مع برامج SGMLtools (http://www.sgmltools.org/).

يوجد ملف إخراج منفرد لكل ملف من ملفات المصدر وملف فهرس.

استخدم cxref عبر الإنترنت باستخدام خدمات onworks.net