السيارات توليد وظيفة في وثائق Visual Studio

Question

أنا أتساءل عما إذا كان هناك طريقة (أمل اختصار لوحة المفاتيح) إلى إنشاء تلقائي إنشاء وظيفة رؤوس في visual studio.

على سبيل المثال:

Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

ومن التلقائى تصبح شيئا من هذا القبيل...

'---------------------------------- 
'Pre: 
'Post:
'Author: 
'Date: 
'Param1 (String): 
'Param2 (Integer): 
'Summary: 
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

Answer 1

تأكد أن "ثلاثة تعليق-علامات واحدة"

في C # انها ///

وعلى النحو الذي يبصق الافتراضي من:

/// <summary>
/// 
/// </summary>
/// <returns></returns>

إليك بعض النصائح حول تحرير القوالب VS .

Answer 2

GhostDoc !

وانقر بزر الماوس الأيمن على وظيفة، حدد "مستند هذا" و

private bool FindTheFoo(int numberOfFoos)

ويصبح

/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)

و(نعم، كل ذلك هو يتم إنشاؤه تلقائيا).

وفقد الدعم لC #، VB.NET و C / C ++. فمن في تعيين الافتراضي إلى السيطرة + التحول + D .

وتذكر: يجب عليك إضافة معلومات تتجاوز توقيع الأسلوب إلى الوثائق. لا تتوقف فقط مع الوثائق المعدة تلقائيا. قيمة أداة مثل هذا هو أنه يولد تلقائيا الوثائق التي يمكن استخلاصها من توقيع الأسلوب، لذلك ينبغي أن يكون أي معلومات تضيفها <م> الجديدة المعلومات.

وأن يقال، وأنا شخصيا أفضل عندما طرق وselfdocumenting تماما، لكن في بعض الأحيان سيكون لديك الترميز المعايير التي تخول وثائق الخارجية، ومن ثم أداة مثل هذا سيوفر لك الكثير من الكتابة braindead.

Answer 3

///

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

وبعد ذلك فوق اسم الدالة اكتب فقط ///

و، وسوف تحصل تلقائيا

Answer 4

والبصرية المساعدة لديه حل لطيف جدا، وغير costumizable للغاية.

وبعد تعديله لتوليد تعليقات على غرار doxygen، فإن هذه بنقرتين إنتاج -

/**
* Method:    FindTheFoo
* FullName:  FindTheFoo
* Access:    private 
* Qualifier:
* @param    int numberOfFoos
* @return   bool
*/
private bool FindTheFoo(int numberOfFoos)
{

}

و(تحت الإعدادات الافتراضية، في مختلف قليلا.)

---

وتحرير: الطريق إلى تخصيص "وثيقة أسلوب 'نص تحت VassistX-> البصرية مساعدة خيارات> اقتراحات، اختر' تحرير VA القصاصات، اللغة: C ++، النوع: إعادة بيع ديون، ثم انتقل إلى" الطريقة الوثيقة "وتخصيصها. يتم إنشاء المثال أعلاه بواسطة:

Answer 5

عادة, Visual Studio يخلق تلقائيا إذا قمت بإضافة ثلاثة تعليق واحد-علامات فوق شيء كنت ترغب في التعليق (طريقة الطبقة).

في C# هذا من شأنه أن يكون ///.

إذا Visual Studio لا تفعل هذا ، يمكنك تمكين في

خيارات->محرر النص->C#->خيارات متقدمة

وتحقق

توليد وثائق XML التعليقات ///

Answer 6

في البصرية الأساسية، إذا قمت بإنشاء الخاصة بك وظيفة / الفرعية أولا، ثم على خط فوقه، اكتب "ثلاث مرات، وسوف لصناعة السيارات في توليد أكس ذات الصلة للتوثيق. وهذا يدل أيضا عند تمرير الماوس في التحسس، وعندما كنت الاستفادة من وظيفة.

Answer 7

ويمكنك استخدام التعليمات البرمجية المتكررة لادخال أي خطوط تريد.

وبالإضافة إلى ذلك، إذا قمت بكتابة ثلاث علامات الاقتباس المفردة ( '' ') على خط فوق رأس وظيفة، فإنه سيتم إدراج قالب رأس XML التي يمكنك ثم ملء.

وهذه التعليقات XML يمكن تفسيرها من قبل البرامج والوثائق، ويتم تضمينها في إخراج بناء كملف assembly.xml. اذا واصلتم هذا الملف XML مع DLL والمرجعية التي DLL في مشروع آخر، تصبح تلك التعليقات المتاحة في التحسس.

Answer 8

وأعمل على طالب Todoc مشروع مفتوح المصدر الذي يحلل الكلمات لتنتج مخرجات الوثائق المناسبة تلقائيا عند حفظ الملف. أنها تحترم التعليقات الموجودة وسريع حقا والسوائل.

http://todoc.codeplex.com/