Hi,

I am wondering why my comments do not appear in intellisense.

I have written the following method:

/// <summary>
/// testing
/// </summary>
/// <param name="stem">will this work?</param>
public void test(string stem)
{

}

If I compile/build this code, and try to call it, the summary doesn't appear
in the intellisense. Any idea why?

Thanks very much.

Verify that you are moving the XML file created along with your assembly (if
you are copying myassembly.dll to where you're referencing it, make sure
you've also copied myassembly.xml )


"suzy" <(E-Mail Removed)> wrote in message
news:%(E-Mail Removed)...
> Hi,
>
> I am wondering why my comments do not appear in intellisense.
>
> I have written the following method:
>
> /// <summary>
> /// testing
> /// </summary>
> /// <param name="stem">will this work?</param>
> public void test(string stem)
> {
>
> }
>
> If I compile/build this code, and try to call it, the summary doesn't
appear
> in the intellisense. Any idea why?
>
> Thanks very much.
>
>

suzy <(E-Mail Removed)> wrote:
> I am wondering why my comments do not appear in intellisense.
>
> I have written the following method:
>
> /// <summary>
> /// testing
> /// </summary>
> /// <param name="stem">will this work?</param>
> public void test(string stem)
> {
>
> }
>
> If I compile/build this code, and try to call it, the summary doesn't appear
> in the intellisense. Any idea why?

Do you mean you're using it from a different solution? If so, you need
to build the XML documentation file and keep that with the assembly.

--
Jon Skeet - <(E-Mail Removed)>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

The XML file that is generated is in the bin\Debug folder.

I haven't moved the assembly anywhere, I am trying to get it working in
design time. Still no joy.

I am a newbie by the way.



"Philip Rieck" <(E-Mail Removed)> wrote in message
news:%(E-Mail Removed)...
> Verify that you are moving the XML file created along with your assembly
(if
> you are copying myassembly.dll to where you're referencing it, make sure
> you've also copied myassembly.xml )
>
>
> "suzy" <(E-Mail Removed)> wrote in message
> news:%(E-Mail Removed)...
> > Hi,
> >
> > I am wondering why my comments do not appear in intellisense.
> >
> > I have written the following method:
> >
> > /// <summary>
> > /// testing
> > /// </summary>
> > /// <param name="stem">will this work?</param>
> > public void test(string stem)
> > {
> >
> > }
> >
> > If I compile/build this code, and try to call it, the summary doesn't
> appear
> > in the intellisense. Any idea why?
> >
> > Thanks very much.
> >
> >
>
>

OK I must be really missing something here.

Jon,

yes you are right, i am accessing this code from another solution. I tried
creating a documentation file (which created lots of html files etc in a
folder called "CodeCommentReport". There is no xml file here though).

I have also tried copying the doc.xml file that was created when I build the
solution into the same dir as my code files and that didn't work either.

What do I do from here, because it's still now working.



"Jon Skeet [C# MVP]" <(E-Mail Removed)> wrote in message
news:(E-Mail Removed)...
> suzy <(E-Mail Removed)> wrote:
> > I am wondering why my comments do not appear in intellisense.
> >
> > I have written the following method:
> >
> > /// <summary>
> > /// testing
> > /// </summary>
> > /// <param name="stem">will this work?</param>
> > public void test(string stem)
> > {
> >
> > }
> >
> > If I compile/build this code, and try to call it, the summary doesn't
appear
> > in the intellisense. Any idea why?
>
> Do you mean you're using it from a different solution? If so, you need
> to build the XML documentation file and keep that with the assembly.
>
> --
> Jon Skeet - <(E-Mail Removed)>
> http://www.pobox.com/~skeet
> If replying to the group, please do not mail me too

suzy <(E-Mail Removed)> wrote:
> yes you are right, i am accessing this code from another solution. I tried
> creating a documentation file (which created lots of html files etc in a
> folder called "CodeCommentReport". There is no xml file here though).

Nope, you don't want to do that. Intellisense is looking for the XML
file, not HTML.

> I have also tried copying the doc.xml file that was created when I build the
> solution into the same dir as my code files and that didn't work either.
>
> What do I do from here, because it's still now working.

You should name the XML file the same as your assembly, but with .xml
on the end instead of .dll. For instance:

MyCompany.Foo.dll and MyCompany.Foo.xml

If they're both in the same directory with the naming scheme above,
VS.NET should pick them up.

--
Jon Skeet - <(E-Mail Removed)>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

"suzy" <(E-Mail Removed)> wrote in message
news:(E-Mail Removed)...
> OK I must be really missing something here.
>
> Jon,
>
> yes you are right, i am accessing this code from another solution. I
tried
> creating a documentation file (which created lots of html files etc in a
> folder called "CodeCommentReport". There is no xml file here though).
>
> I have also tried copying the doc.xml file that was created when I build
the
> solution into the same dir as my code files and that didn't work either.
>
> What do I do from here, because it's still now working.
>
>
>

Just to go over the steps, these work for us:
1) in the project properties, write a filename for XML documentation
(Configuration Properties | Build)
the default name seems to be: same directory/filename as dll,
except a ".xml" extension instead of ".dll"
2) REbuild the project to generate/update this XML file,
no need to generate the documentation html-files.
(If you just "build" the project then the xml-file is not updated.)
3) reference this dll in the other project, xml (and pdb) files
are automatically copied


Hans Kesting

Great Hans,

Thanks so much, that works (finally!!!)




"Hans Kesting" <(E-Mail Removed)> wrote in message
news:(E-Mail Removed)...
>
> "suzy" <(E-Mail Removed)> wrote in message
> news:(E-Mail Removed)...
> > OK I must be really missing something here.
> >
> > Jon,
> >
> > yes you are right, i am accessing this code from another solution. I
> tried
> > creating a documentation file (which created lots of html files etc in a
> > folder called "CodeCommentReport". There is no xml file here though).
> >
> > I have also tried copying the doc.xml file that was created when I build
> the
> > solution into the same dir as my code files and that didn't work either.
> >
> > What do I do from here, because it's still now working.
> >
> >
> >
>
> Just to go over the steps, these work for us:
> 1) in the project properties, write a filename for XML documentation
> (Configuration Properties | Build)
> the default name seems to be: same directory/filename as dll,
> except a ".xml" extension instead of ".dll"
> 2) REbuild the project to generate/update this XML file,
> no need to generate the documentation html-files.
> (If you just "build" the project then the xml-file is not updated.)
> 3) reference this dll in the other project, xml (and pdb) files
> are automatically copied
>
>
> Hans Kesting
>
>

One final point:

After you have changed & recompiled your library project/solution,
you need to recompile the project (solution) you are using it in, so the
new dll + xml are picked up.

Hans Kesting


"suzy" <(E-Mail Removed)> wrote in message
news:%(E-Mail Removed)...
> Great Hans,
>
> Thanks so much, that works (finally!!!)
>
>
>
>
> "Hans Kesting" <(E-Mail Removed)> wrote in message
> news:(E-Mail Removed)...
> >
> >
> > Just to go over the steps, these work for us:
> > 1) in the project properties, write a filename for XML documentation
> > (Configuration Properties | Build)
> > the default name seems to be: same directory/filename as dll,
> > except a ".xml" extension instead of ".dll"
> > 2) REbuild the project to generate/update this XML file,
> > no need to generate the documentation html-files.
> > (If you just "build" the project then the xml-file is not updated.)
> > 3) reference this dll in the other project, xml (and pdb) files
> > are automatically copied
> >
> >
> > Hans Kesting
> >
> >
>
>