how I can add comments to a dll (Class Library)

Question

5.00/5 (1 vote)

See more:

I'm working in Visual Basic, then add some comments like this

''' <summary>
''' Metodo que toma una frase codificada en utf8 o iso, ya sea en base64 o en
''' Quoted-Printable de la cual se obtiene un string decodificado y legible
''' </summary>
''' <param name="FraseCodificada">Frase codificada</param>
''' <returns>Frase decodificada</returns>
''' <remarks></remarks>

I can't see them from another project that uses the dll,
someone knows how to do it?

thanks

Edit:

I noticed today that the summary of the dll is stored as a comment line ' and not as a ''' comment

Posted 20-Jun-11 9:30am

pepito del puerto

Updated 8-Nov-16 0:24am

v2

Add a Solution

5 solutions

Solution 4

two ways..

1. You can use /// in C# or ''' in VB for comments.

2. Another way of doing comments is using [] for attributes, but that stuff will goes to COM.

Posted 21-Jun-11 0:20am

Harmanjeet Singh

Comments

pepito del puerto 21-Jun-11 9:29am

I use ''' but I can't see the comments from another proyect that uses my dll

Harmanjeet Singh 21-Jun-11 17:58pm

See, if, you r using ''' comments, the code shud work. one thing to make you confirm. try the same thing in a new project. it shud definitely work there..

Solution 6

Under "Build->Configuration Manager..." in a Class Library project it must be set to "Any CPU". Doesn´t matter if it is "Release" or "Debug".

Posted 8-Nov-16 0:23am

Member 12139350

Comments

[no name] 8-Nov-16 8:05am

Well done. Resurrecting a FIVE year old already answered question to post a solution that has nothing to do with the question asked.

CHill60 12-Nov-16 21:16pm

Rubbish.

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Tarakeshwar Reddy · Accepted Answer · 2011-06-20T09:58:00

Solution 2

In your project Properties->Build, make sure the "XML Documentation file" checkbox is checked.

Posted 20-Jun-11 9:58am

Tarakeshwar Reddy

Comments

Sergey Alexandrovich Kryukov 20-Jun-11 21:44pm

My, 5.
May be OP does not no C# XML help syntax as opposed to VB.NET?
Please see my answer.
--SA

Sergey Alexandrovich Kryukov · Accepted Answer · 2011-06-20T15:43:00

Solution 3

Go one line above some public declaration: a type or its a public member of a public type, and type "///", three (3) slashed -- VS should create a template XML help item for you.

[EDIT]
To more things to check: 1) usually comments are enabled to Debug configuration and not for Release, 2) project build should create XML file; this file should be accessible when you browse the built assembly.

—SA

Posted 20-Jun-11 15:43pm

Sergey Alexandrovich Kryukov

Updated 21-Jun-11 5:18am

v2

Comments

Tarun.K.S 21-Jun-11 6:55am

I don't think that's the OP's doubt. OP's project uses a dll which cannot be opened. OP wants to add comments to the classes in present in that dll.

Sergey Alexandrovich Kryukov 21-Jun-11 11:19am

Just trying to help OP to check all that may be relevant.
--SA

pepito del puerto 21-Jun-11 9:26am

I use ''' in VB but when I see the functions in another proyect that uses the dll I don't see anything only the declaration for example

Public Function functionX As String

and thats all

pepito del puerto 22-Jun-11 9:35am

The solution was to copy the xml file generated in the dll project to where the dll was copied, thanks to all

Sergey Alexandrovich Kryukov 22-Jun-11 18:18pm

Great. You're welcome.
Good luck, call again.
--SA

#realJSOP · Accepted Answer · 2011-06-20T09:39:00

Solution 1

Do you have intellisense turned on?

Posted 20-Jun-11 9:39am

#realJSOP

Comments

pepito del puerto 20-Jun-11 15:46pm

yes, i can only see the Function without my comments

Sergey Alexandrovich Kryukov 20-Jun-11 21:44pm

My, 5.
May be OP does not no C# XML help syntax as opposed to VB.NET?
Please see my answer.
--SA