Summary comments

If you type /// at the top of a method some XML is inserted for you, this includes a summary, params, and result. On our team we require some other items to be added to the list as well. As I type them in I get some code insight for available node names. My question is:

How can I add my custom nodes to the available node names in the code insight window


Thanks

Wayne



Answer this question

Summary comments

  • Anurag Banka

    Wayne -

    We'll take this feedback for future versions.

    As for what you can use now, you can create your own snippet (and share these across your team on a network share), that will automatically insert the fields you need and place the cursor inside the " " in DatabaseName.

    Here is information on how to create these snippets:

    http://msdn2.microsoft.com/en-us/library/ms165392(VS.80).aspx

    HTH,

    Karen



  • Key_46

    I am moving this thread to the C# forum to see if they will be able to answer your question better. Feel free to post on the VB forum if you'd like to know how to customize VB.

    Thanks,

    Dylan



  • alexander.wf

    Yes currently C#, but I'd like to know how to do it in a general way in case I get some VB work in the future. However, for now how to do it in C# would be acceptable.


    Thanks

    Wayne


  • 1Dave

    Wayne,

    Are you using one language in paticular If you are, can you ask on the language specific forum If not, let me know and I'll look into this some more.

    Thanks,

    Dylan



  • Display_Name_mladen

    Wayne,

    If what you're asking is how to modify the text that is inserted when you type "///", then I'm sad to say there is currently no way to do this. The only control we currently provide in this area is an option to turn the insertion on or off; this can be accessed through the Tools/Options menu item and is located under Text Editor/C#/Advanced.

    For our future reference, what kind of functionality are you looking for in this area The ability to modify the inserted text in the same way you can modify, say, a code snippet Or something else

    -Tom Meschter
    Software Dev, Visual C# IDE



  • 5c0tt

    Currently our header standards are as follows:

    /// <summary>
    /// ALready given to us by typing ///
    /// </summary>
    /// <returns>ALready given to us by typing ///</returns>
    Then we have the following section we need to put in:

    If we are using any databases directly in the method we need:

    /// <DB DatabaseName="">
    /// <storedProcedures>
    /// <procName></procName>
    /// </storedProcedures>
    /// </DB>

    For any changes to a method we require you put in
    /// <History>
    /// <Intials></Intials>
    /// <Date></Date>
    /// <Description></Description>
    /// </History>


    What I was hoping for was to have the Schema of our requirements be added to the summary headers, so when you type "<" DB and History are presented as options. I don't want to change what is automatticly typed as DB and History are optional.


  • Summary comments