سؤال

عند أنا النامية في C #، I بشدة استخدام GhostDoc لتسريع عملية التعليق قانون بلدي. أنا أعمل حاليا على مشروع C ++ و لم أجد وسيلة ما يعادلها. أعرف عن Doxygen، ولكن من ما أعرفه يتم استخدامها لإنشاء وثائق خارج رمز، لا تعليق في التعليمات البرمجية. هل هناك أي أدوات يعادل جيدة؟ وأود أن تفضل واحد الذي يعمل في VS، لكنني قادرة على التعامل مع واحد أن يعمل في أي IDE.

و(قبل شخص يجلب عنه، وأنا لا تعتمد فقط على GhostDoc لخلق التعليقات. أنا مجرد استخدامه لإنشاء نقطة الانطلاق لتعليقاتي.)

هل كانت مفيدة؟

المحلول

البصرية مساعدة يساعد من خلال توفير البرامج النصية المخصصة تنفيذها أثناء الكتابة (أو على غيره).

وعلى سبيل المثال، يمكن أن يكون لديك برنامج نصي لتعليقات مثل هذا:

/************************************************************************/
/* My comment : $end$                                                                     */
/************************************************************************/

وسوف اقترح ذلك (عن طريق مربع التحرير والسرد تماما مثل التحسس) عند البدء في الكتابة "/ **" على سبيل المثال. عند تحديد هذا الاقتراح (عن طريق إدخال / الفضاء / اضغط - تخصيص)، فإنه سيتم إدراج البرنامج النصي حيث المؤشر الخاص بك هو ومجرد استبدال علامات التي هي بين الأحرف '$' بالقيم الخاصة (مثل اسم الملف الحالي على سبيل المثال). هنا $ $ نهاية علامة سيجعل المؤشر يكون في هذا الموقف عندما يتم تنفيذ البرنامج النصي. بهذه الطريقة، يمكنك متابعة الكتابة على نحو سلس. على سبيل المثال مع مجموعة النصي السابق، وكتابة بالضبط:

/** this is a test comment to show you one of the many features Visual Assit!

وسوف تعطي ببساطة:

/************************************************************************/
/* My comment : this is a test comment to show you one of the many features Visual Assit!                                                                     */
/************************************************************************/

وانه من السهل حقا لتخصيص وسلوك اقتراح (قراءة: التحسس ++). النظام هو تخصيص

نصائح أخرى

ولقد كتبت وظيفة إضافية في، أو Atomineer برو الوثائق ، أو وهي تشبه الى حد بعيد GhostDoc (أنه يولد تعليقات الوثائق / التحديثات لانقاذ الكثير من الوقت والجهد عند توثيق)، لكنه يوزع رمز مباشرة لنفسها، وبالتالي غير قادرة على التعامل مع C، C ++، C ++ / CLI، C #، جافا والبرمجية ل Visual Basic، و لا يتطلب رمز المحيطة بها لتكون في حالة تجميع قبل أنه سوف يعمل. فإنه سيتم أيضا تلقائيا إضافة وثائق تحديث / لأمور أكثر صعبة مثل استثناءات القيت داخل الجسم من طريقة.

وتشغيله ضمن Visual ستوديو 11، 2010، 2008 و 2005، ويدعم التوثيق-XML، Doxygen، جافادوك وكيو تي صيغ التعليق، وكذلك شكل / نمط من كتل تعليق وقواعد صناعة السيارات في وثيقة استخدمت يجري شكلي للغاية . أنه يحتوي على عدد من الميزات سهلة الاستخدام أخرى مثل المساعدة التحويلات من إرث DOC-تعليقات إلى الأشكال المذكورة أعلاه، وكلمة التفاف في وثيقة-تعليقات وتصريحات كتلة العادية.

ما سبق هو مجرد ملخص لبعض الملامح الرئيسية - وهذا مقارنة ميزات مع الآخر منتجات بمثابة قائمة أكثر اكتمالا من العديد من الميزات الأخرى المتاحة.

البصرية مساعدة قد القيام بهذه المهمة، على الرغم من أنني لست متأكدا تماما.

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top