C# XML Commenting


DevX Home    Today's Headlines   Articles Archive   Tip Bank   Forums   

Results 1 to 9 of 9

Thread: C# XML Commenting

  1. #1
    Patrick Long Guest

    C# XML Commenting

    I want to use this to give users of my classes better intellisense. The XML
    commenting facility allows you to add descriptions to your parameters and
    methods. These appewar just like they do when you use the supplied base
    classes.

    So far i have only been able to get the extra intellisense to appear when
    using classes all within the same project. Is this information not added to
    the assembly's meta data?

    Pat



  2. #2
    Peter Drayton Guest

    Re: C# XML Commenting

    No, it is not.

    --Peter
    http://staff.develop.com/peterd

    "Patrick Long" <Patrick_long@csi.com> wrote in message
    news:3b34ac1c@news.devx.com...
    > I want to use this to give users of my classes better intellisense. The

    XML
    > commenting facility allows you to add descriptions to your parameters and
    > methods. These appewar just like they do when you use the supplied base
    > classes.
    >
    > So far i have only been able to get the extra intellisense to appear when
    > using classes all within the same project. Is this information not added

    to
    > the assembly's meta data?
    >
    > Pat
    >
    >




  3. #3
    Patrick Long Guest

    Re: C# XML Commenting

    thanks and sorry you had to read it in the ms.public group as well
    "Peter Drayton" <peter@razorsoft.com> wrote in message
    news:3b34e407$1@news.devx.com...
    > No, it is not.
    >
    > --Peter
    > http://staff.develop.com/peterd
    >
    > "Patrick Long" <Patrick_long@csi.com> wrote in message
    > news:3b34ac1c@news.devx.com...
    > > I want to use this to give users of my classes better intellisense. The

    > XML
    > > commenting facility allows you to add descriptions to your parameters

    and
    > > methods. These appewar just like they do when you use the supplied base
    > > classes.
    > >
    > > So far i have only been able to get the extra intellisense to appear

    when
    > > using classes all within the same project. Is this information not added

    > to
    > > the assembly's meta data?
    > >
    > > Pat
    > >
    > >

    >
    >




  4. #4
    Eric Gunnerson Guest

    Re: C# XML Commenting

    Note that you can take the generated XML file, add it to your project, and
    get intellisense for other assemblies.

    "Patrick Long" <Patrick_long@csi.com> wrote in message
    news:3b34f585@news.devx.com...
    > thanks and sorry you had to read it in the ms.public group as well
    > "Peter Drayton" <peter@razorsoft.com> wrote in message
    > news:3b34e407$1@news.devx.com...
    > > No, it is not.
    > >
    > > --Peter
    > > http://staff.develop.com/peterd
    > >
    > > "Patrick Long" <Patrick_long@csi.com> wrote in message
    > > news:3b34ac1c@news.devx.com...
    > > > I want to use this to give users of my classes better intellisense.

    The
    > > XML
    > > > commenting facility allows you to add descriptions to your parameters

    > and
    > > > methods. These appewar just like they do when you use the supplied

    base
    > > > classes.
    > > >
    > > > So far i have only been able to get the extra intellisense to appear

    > when
    > > > using classes all within the same project. Is this information not

    added
    > > to
    > > > the assembly's meta data?
    > > >
    > > > Pat
    > > >
    > > >

    > >
    > >

    >
    >




  5. #5
    Paul Jackson Guest

    Re: C# XML Commenting

    Eric,

    This sounds great, but I cannot get it to work. I have had the IDE create me
    the necessary XML file. I have added the XML file to the project that I'm
    using my assembly on and I'm not getting the intellisense features.

    I have also tried compiling my assembly with the XML included and included
    the XML file in to the new project and still no joy. Could you please
    elaborate on how to achieve this or point me in the direction of some
    documentation.

    Thanks very much.

    Paul Jackson
    pr_jackson@hotmail.com

    P.S. Eric, I am currently ready your book "A Programmers Introduction to C#
    2nd edition" (I have also read your 1st edition of the book) and I am
    enjoying it very much. Keep up the excellent work. PJ

    "Eric Gunnerson" <ericgu_nospam@microsoft.nospam.com> wrote in message
    news:3b3fbed2$1@news.devx.com...
    > Note that you can take the generated XML file, add it to your project, and
    > get intellisense for other assemblies.
    >
    > "Patrick Long" <Patrick_long@csi.com> wrote in message
    > news:3b34f585@news.devx.com...
    > > thanks and sorry you had to read it in the ms.public group as well
    > > "Peter Drayton" <peter@razorsoft.com> wrote in message
    > > news:3b34e407$1@news.devx.com...
    > > > No, it is not.
    > > >
    > > > --Peter
    > > > http://staff.develop.com/peterd
    > > >
    > > > "Patrick Long" <Patrick_long@csi.com> wrote in message
    > > > news:3b34ac1c@news.devx.com...
    > > > > I want to use this to give users of my classes better intellisense.

    > The
    > > > XML
    > > > > commenting facility allows you to add descriptions to your

    parameters
    > > and
    > > > > methods. These appewar just like they do when you use the supplied

    > base
    > > > > classes.
    > > > >
    > > > > So far i have only been able to get the extra intellisense to appear

    > > when
    > > > > using classes all within the same project. Is this information not

    > added
    > > > to
    > > > > the assembly's meta data?
    > > > >
    > > > > Pat
    > > > >
    > > > >
    > > >
    > > >

    > >
    > >

    >
    >




  6. #6
    Eric Gunnerson Guest

    Re: C# XML Commenting

    I'll see what I can help. I think the proper set of steps is:

    1) Make sure the generated .XML file is the same name as the assembly (ie
    utility.dll and utility.xml).
    2) Put the xml file in the same directory as the assembly.

    In step 2, I think adding the XML file to the project may put it in a
    different directory than the assembly, as I think the assembly gets put in
    the bin directory, and the XML in the main directory.


    "Paul Jackson" <pr_jackson@hotmail.com> wrote in message
    news:3bbb2d31$1@news.devx.com...
    > Eric,
    >
    > This sounds great, but I cannot get it to work. I have had the IDE create

    me
    > the necessary XML file. I have added the XML file to the project that I'm
    > using my assembly on and I'm not getting the intellisense features.
    >
    > I have also tried compiling my assembly with the XML included and included
    > the XML file in to the new project and still no joy. Could you please
    > elaborate on how to achieve this or point me in the direction of some
    > documentation.
    >
    > Thanks very much.
    >
    > Paul Jackson
    > pr_jackson@hotmail.com
    >
    > P.S. Eric, I am currently ready your book "A Programmers Introduction to

    C#
    > 2nd edition" (I have also read your 1st edition of the book) and I am
    > enjoying it very much. Keep up the excellent work. PJ
    >
    > "Eric Gunnerson" <ericgu_nospam@microsoft.nospam.com> wrote in message
    > news:3b3fbed2$1@news.devx.com...
    > > Note that you can take the generated XML file, add it to your project,

    and
    > > get intellisense for other assemblies.
    > >
    > > "Patrick Long" <Patrick_long@csi.com> wrote in message
    > > news:3b34f585@news.devx.com...
    > > > thanks and sorry you had to read it in the ms.public group as well
    > > > "Peter Drayton" <peter@razorsoft.com> wrote in message
    > > > news:3b34e407$1@news.devx.com...
    > > > > No, it is not.
    > > > >
    > > > > --Peter
    > > > > http://staff.develop.com/peterd
    > > > >
    > > > > "Patrick Long" <Patrick_long@csi.com> wrote in message
    > > > > news:3b34ac1c@news.devx.com...
    > > > > > I want to use this to give users of my classes better

    intellisense.
    > > The
    > > > > XML
    > > > > > commenting facility allows you to add descriptions to your

    > parameters
    > > > and
    > > > > > methods. These appewar just like they do when you use the supplied

    > > base
    > > > > > classes.
    > > > > >
    > > > > > So far i have only been able to get the extra intellisense to

    appear
    > > > when
    > > > > > using classes all within the same project. Is this information not

    > > added
    > > > > to
    > > > > > the assembly's meta data?
    > > > > >
    > > > > > Pat
    > > > > >
    > > > > >
    > > > >
    > > > >
    > > >
    > > >

    > >
    > >

    >
    >




  7. #7
    Paul Jackson Guest

    Re: C# XML Commenting

    Thanks Eric, that's fantastic. What a great feature!

    Paul


    "Eric Gunnerson" <ericgu_nospam@microsoft.nospam.com> wrote in message
    news:3bbb3f7c$1@news.devx.com...
    > I'll see what I can help. I think the proper set of steps is:
    >
    > 1) Make sure the generated .XML file is the same name as the assembly (ie
    > utility.dll and utility.xml).
    > 2) Put the xml file in the same directory as the assembly.
    >
    > In step 2, I think adding the XML file to the project may put it in a
    > different directory than the assembly, as I think the assembly gets put in
    > the bin directory, and the XML in the main directory.
    >
    >
    > "Paul Jackson" <pr_jackson@hotmail.com> wrote in message
    > news:3bbb2d31$1@news.devx.com...
    > > Eric,
    > >
    > > This sounds great, but I cannot get it to work. I have had the IDE

    create
    > me
    > > the necessary XML file. I have added the XML file to the project that

    I'm
    > > using my assembly on and I'm not getting the intellisense features.
    > >
    > > I have also tried compiling my assembly with the XML included and

    included
    > > the XML file in to the new project and still no joy. Could you please
    > > elaborate on how to achieve this or point me in the direction of some
    > > documentation.
    > >
    > > Thanks very much.
    > >
    > > Paul Jackson
    > > pr_jackson@hotmail.com
    > >
    > > P.S. Eric, I am currently ready your book "A Programmers Introduction to

    > C#
    > > 2nd edition" (I have also read your 1st edition of the book) and I am
    > > enjoying it very much. Keep up the excellent work. PJ
    > >
    > > "Eric Gunnerson" <ericgu_nospam@microsoft.nospam.com> wrote in message
    > > news:3b3fbed2$1@news.devx.com...
    > > > Note that you can take the generated XML file, add it to your project,

    > and
    > > > get intellisense for other assemblies.
    > > >
    > > > "Patrick Long" <Patrick_long@csi.com> wrote in message
    > > > news:3b34f585@news.devx.com...
    > > > > thanks and sorry you had to read it in the ms.public group as well
    > > > > "Peter Drayton" <peter@razorsoft.com> wrote in message
    > > > > news:3b34e407$1@news.devx.com...
    > > > > > No, it is not.
    > > > > >
    > > > > > --Peter
    > > > > > http://staff.develop.com/peterd
    > > > > >
    > > > > > "Patrick Long" <Patrick_long@csi.com> wrote in message
    > > > > > news:3b34ac1c@news.devx.com...
    > > > > > > I want to use this to give users of my classes better

    > intellisense.
    > > > The
    > > > > > XML
    > > > > > > commenting facility allows you to add descriptions to your

    > > parameters
    > > > > and
    > > > > > > methods. These appewar just like they do when you use the

    supplied
    > > > base
    > > > > > > classes.
    > > > > > >
    > > > > > > So far i have only been able to get the extra intellisense to

    > appear
    > > > > when
    > > > > > > using classes all within the same project. Is this information

    not
    > > > added
    > > > > > to
    > > > > > > the assembly's meta data?
    > > > > > >
    > > > > > > Pat
    > > > > > >
    > > > > > >
    > > > > >
    > > > > >
    > > > >
    > > > >
    > > >
    > > >

    > >
    > >

    >
    >




  8. #8
    Ollie Cornes Guest

    Re: C# XML Commenting



    Paul, you might be interested in a piece I wrote the other
    day on XML commenting in C#. For me, the most interesting part
    is the coverage of DOC.NET, which is a tool that generates
    documentation just like MSDN.

    http://www.squiffler.com/article.aspx?id=1

    XML commenting is just fantastic.

    Ollie


    "Paul Jackson" <pr_jackson@hotmail.com> wrote:
    >Thanks Eric, that's fantastic. What a great feature!
    >
    >Paul
    >
    >
    >"Eric Gunnerson" <ericgu_nospam@microsoft.nospam.com> wrote in message
    >news:3bbb3f7c$1@news.devx.com...
    >> I'll see what I can help. I think the proper set of steps is:
    >>
    >> 1) Make sure the generated .XML file is the same name as the assembly

    (ie
    >> utility.dll and utility.xml).
    >> 2) Put the xml file in the same directory as the assembly.
    >>
    >> In step 2, I think adding the XML file to the project may put it in a
    >> different directory than the assembly, as I think the assembly gets put

    in
    >> the bin directory, and the XML in the main directory.
    >>
    >>
    >> "Paul Jackson" <pr_jackson@hotmail.com> wrote in message
    >> news:3bbb2d31$1@news.devx.com...
    >> > Eric,
    >> >
    >> > This sounds great, but I cannot get it to work. I have had the IDE

    >create
    >> me
    >> > the necessary XML file. I have added the XML file to the project that

    >I'm
    >> > using my assembly on and I'm not getting the intellisense features.
    >> >
    >> > I have also tried compiling my assembly with the XML included and

    >included
    >> > the XML file in to the new project and still no joy. Could you please
    >> > elaborate on how to achieve this or point me in the direction of some
    >> > documentation.
    >> >
    >> > Thanks very much.
    >> >
    >> > Paul Jackson
    >> > pr_jackson@hotmail.com
    >> >
    >> > P.S. Eric, I am currently ready your book "A Programmers Introduction

    to
    >> C#
    >> > 2nd edition" (I have also read your 1st edition of the book) and I am
    >> > enjoying it very much. Keep up the excellent work. PJ
    >> >
    >> > "Eric Gunnerson" <ericgu_nospam@microsoft.nospam.com> wrote in message
    >> > news:3b3fbed2$1@news.devx.com...
    >> > > Note that you can take the generated XML file, add it to your project,

    >> and
    >> > > get intellisense for other assemblies.
    >> > >
    >> > > "Patrick Long" <Patrick_long@csi.com> wrote in message
    >> > > news:3b34f585@news.devx.com...
    >> > > > thanks and sorry you had to read it in the ms.public group as well
    >> > > > "Peter Drayton" <peter@razorsoft.com> wrote in message
    >> > > > news:3b34e407$1@news.devx.com...
    >> > > > > No, it is not.
    >> > > > >
    >> > > > > --Peter
    >> > > > > http://staff.develop.com/peterd
    >> > > > >
    >> > > > > "Patrick Long" <Patrick_long@csi.com> wrote in message
    >> > > > > news:3b34ac1c@news.devx.com...
    >> > > > > > I want to use this to give users of my classes better

    >> intellisense.
    >> > > The
    >> > > > > XML
    >> > > > > > commenting facility allows you to add descriptions to your
    >> > parameters
    >> > > > and
    >> > > > > > methods. These appewar just like they do when you use the

    >supplied
    >> > > base
    >> > > > > > classes.
    >> > > > > >
    >> > > > > > So far i have only been able to get the extra intellisense to

    >> appear
    >> > > > when
    >> > > > > > using classes all within the same project. Is this information

    >not
    >> > > added
    >> > > > > to
    >> > > > > > the assembly's meta data?
    >> > > > > >
    >> > > > > > Pat
    >> > > > > >
    >> > > > > >
    >> > > > >
    >> > > > >
    >> > > >
    >> > > >
    >> > >
    >> > >
    >> >
    >> >

    >>
    >>

    >
    >



  9. #9
    Paul Jackson Guest

    Re: C# XML Commenting

    Ollie,

    Thanks for the heads-up. I have had a read of the article and it's very
    interesting. I shall be checking out the DOC.Net/NDOC stuff today!

    Thanks

    Paul Jackson
    pr_jackson@hotmail.com


    "Ollie Cornes" <ollie@cornes.org> wrote in message
    news:3bbef2c0$1@news.devx.com...
    >
    >
    > Paul, you might be interested in a piece I wrote the other
    > day on XML commenting in C#. For me, the most interesting part
    > is the coverage of DOC.NET, which is a tool that generates
    > documentation just like MSDN.
    >
    > http://www.squiffler.com/article.aspx?id=1
    >
    > XML commenting is just fantastic.
    >
    > Ollie
    >
    >
    > "Paul Jackson" <pr_jackson@hotmail.com> wrote:
    > >Thanks Eric, that's fantastic. What a great feature!
    > >
    > >Paul
    > >
    > >
    > >"Eric Gunnerson" <ericgu_nospam@microsoft.nospam.com> wrote in message
    > >news:3bbb3f7c$1@news.devx.com...
    > >> I'll see what I can help. I think the proper set of steps is:
    > >>
    > >> 1) Make sure the generated .XML file is the same name as the assembly

    > (ie
    > >> utility.dll and utility.xml).
    > >> 2) Put the xml file in the same directory as the assembly.
    > >>
    > >> In step 2, I think adding the XML file to the project may put it in a
    > >> different directory than the assembly, as I think the assembly gets put

    > in
    > >> the bin directory, and the XML in the main directory.
    > >>
    > >>
    > >> "Paul Jackson" <pr_jackson@hotmail.com> wrote in message
    > >> news:3bbb2d31$1@news.devx.com...
    > >> > Eric,
    > >> >
    > >> > This sounds great, but I cannot get it to work. I have had the IDE

    > >create
    > >> me
    > >> > the necessary XML file. I have added the XML file to the project that

    > >I'm
    > >> > using my assembly on and I'm not getting the intellisense features.
    > >> >
    > >> > I have also tried compiling my assembly with the XML included and

    > >included
    > >> > the XML file in to the new project and still no joy. Could you please
    > >> > elaborate on how to achieve this or point me in the direction of some
    > >> > documentation.
    > >> >
    > >> > Thanks very much.
    > >> >
    > >> > Paul Jackson
    > >> > pr_jackson@hotmail.com
    > >> >
    > >> > P.S. Eric, I am currently ready your book "A Programmers Introduction

    > to
    > >> C#
    > >> > 2nd edition" (I have also read your 1st edition of the book) and I am
    > >> > enjoying it very much. Keep up the excellent work. PJ
    > >> >
    > >> > "Eric Gunnerson" <ericgu_nospam@microsoft.nospam.com> wrote in

    message
    > >> > news:3b3fbed2$1@news.devx.com...
    > >> > > Note that you can take the generated XML file, add it to your

    project,
    > >> and
    > >> > > get intellisense for other assemblies.
    > >> > >
    > >> > > "Patrick Long" <Patrick_long@csi.com> wrote in message
    > >> > > news:3b34f585@news.devx.com...
    > >> > > > thanks and sorry you had to read it in the ms.public group as

    well
    > >> > > > "Peter Drayton" <peter@razorsoft.com> wrote in message
    > >> > > > news:3b34e407$1@news.devx.com...
    > >> > > > > No, it is not.
    > >> > > > >
    > >> > > > > --Peter
    > >> > > > > http://staff.develop.com/peterd
    > >> > > > >
    > >> > > > > "Patrick Long" <Patrick_long@csi.com> wrote in message
    > >> > > > > news:3b34ac1c@news.devx.com...
    > >> > > > > > I want to use this to give users of my classes better
    > >> intellisense.
    > >> > > The
    > >> > > > > XML
    > >> > > > > > commenting facility allows you to add descriptions to your
    > >> > parameters
    > >> > > > and
    > >> > > > > > methods. These appewar just like they do when you use the

    > >supplied
    > >> > > base
    > >> > > > > > classes.
    > >> > > > > >
    > >> > > > > > So far i have only been able to get the extra intellisense to
    > >> appear
    > >> > > > when
    > >> > > > > > using classes all within the same project. Is this

    information
    > >not
    > >> > > added
    > >> > > > > to
    > >> > > > > > the assembly's meta data?
    > >> > > > > >
    > >> > > > > > Pat
    > >> > > > > >
    > >> > > > > >
    > >> > > > >
    > >> > > > >
    > >> > > >
    > >> > > >
    > >> > >
    > >> > >
    > >> >
    > >> >
    > >>
    > >>

    > >
    > >

    >




Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
HTML5 Development Center
 
 
FAQ
Latest Articles
Java
.NET
XML
Database
Enterprise
Questions? Contact us.
C++
Web Development
Wireless
Latest Tips
Open Source


   Development Centers

   -- Android Development Center
   -- Cloud Development Project Center
   -- HTML5 Development Center
   -- Windows Mobile Development Center