如何为dll添加注释(类库) [英] how I can add comments to a dll (Class Library)
问题描述
我正在使用Visual Basic,然后添加一些这样的评论
'''< 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>
我无法从另一个人看到它们使用dll的项目,
有人知道怎么做吗?
谢谢
编辑:
我今天注意到dll的摘要存储为注释行'而不是'''comment
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
I noticed today that the summary of the dll is stored as a comment line ' and not as a ''' comment
推荐答案
在你的项目中属性 - >构建,确保选中XML文档文件复选框。
In your project Properties->Build, make sure the "XML Documentation file" checkbox is checked.
在一些公共声明上面一行:一个类型或公共类型的公共成员,并键入///,三个(3)削减 - VS应该为你创建一个模板XML帮助项目。
要查看更多内容: 1)通常注释启用Debug配置而不是Release,2)项目构建应该创建XML文件;浏览构建的程序集时,应该可以访问此文件。
-SA
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.
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
两种方式..
1.您可以在C#中使用///或在VB中使用'''作为评论。
2.另一种做评论的方法是使用[]作为属性,但那些东西将转到COM。
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.
这篇关于如何为dll添加注释(类库)的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!