Results 1 to 5 of 5

Thread: VS2005 - XML Code Documentation

  1. #1

    Thread Starter
    Lively Member StoneTheCrows's Avatar
    Join Date
    Dec 2004
    Location
    UK
    Posts
    71

    Question VS2005 - XML Code Documentation

    We all know that if you type \\\ on the line above a function or variable definition etc. what you get is:
    Code:
    ///<summary>
    ///
    ///</summary>
    public void myRidiculouslyLongFunctionNameForNoParticularReason()
    {
       DoSomeStuff();
    }
    or maybe
    Code:
    /// <summary>
    /// 
    /// </summary>
    /// <param name="iVal"></param>
    /// <returns></returns>
    public double myLittleMathFunction(int iVal)
    {
         double rVal =  DoSomeMaths();
         return rVal;
    }
    And this is Great.

    Does anyone know if it is possible to change/modify/add to the XML Documentation comments that are generated?
    StoneTheCrows

    _______________

    The future will be better tomorrow. (George W. Bush)

    (If you think my post was useful, please Rate it. Thanks)

  2. #2
    Hyperactive Member Sgt-Peppa's Avatar
    Join Date
    Mar 2003
    Location
    Munich - Germany
    Posts
    476

    Re: VS2005 - XML Code Documentation

    This is a list of recommended Xml-Tags you can use inside your applications to document your code.
    http://msdn2.microsoft.com/library/5...us,vs.80).aspx
    I think there are a couple more, I can post a complete list tomorrow.

    Stephan
    Keep Smiling - even if its hard
    Frankie Says Relax, wossname Says Yeah!
    wossname:--Currently I'm wearing a gimp suit and a parachute.
    C# - Base64 Blog

  3. #3

    Thread Starter
    Lively Member StoneTheCrows's Avatar
    Join Date
    Dec 2004
    Location
    UK
    Posts
    71

    Re: VS2005 - XML Code Documentation

    Quote Originally Posted by Sgt-Peppa
    This is a list of recommended Xml-Tags you can use inside your applications to document your code.
    http://msdn2.microsoft.com/library/5...us,vs.80).aspx
    I think there are a couple more, I can post a complete list tomorrow.

    Stephan
    Stephan,

    Thanks for that. I have to say that I already know what tags can be used, what I am really asking is how do you, or even can you, modify what is inserted automatically when you type /// above a Function/Definition etc.

    For example, I want the automatically generated XML comments to include
    Code:
    ///<remarks>
    ///
    ///</remarks>
    I realise I could type this in manually quite easily, but what you don't realise is that I am incredibly lazy and quite forgetfull, so I want VS2005 to do it for me!

    Hope this clarifys my question.
    StoneTheCrows

    _______________

    The future will be better tomorrow. (George W. Bush)

    (If you think my post was useful, please Rate it. Thanks)

  4. #4
    Hyperactive Member Sgt-Peppa's Avatar
    Join Date
    Mar 2003
    Location
    Munich - Germany
    Posts
    476

    Re: VS2005 - XML Code Documentation

    Oh, ok sorry didnt understand you correct there! Sorry have no idea how to do that! Sorry about the misunderstanding!
    Keep Smiling - even if its hard
    Frankie Says Relax, wossname Says Yeah!
    wossname:--Currently I'm wearing a gimp suit and a parachute.
    C# - Base64 Blog

  5. #5

    Thread Starter
    Lively Member StoneTheCrows's Avatar
    Join Date
    Dec 2004
    Location
    UK
    Posts
    71

    Re: VS2005 - XML Code Documentation

    No Problem
    StoneTheCrows

    _______________

    The future will be better tomorrow. (George W. Bush)

    (If you think my post was useful, please Rate it. Thanks)

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  



Click Here to Expand Forum to Full Width