[RESOLVED] [2005] Method's Summaries?
Hi guys, I have this small problem and could use some help solving it. I have created a Class Library project that builds a Dll file. The problem I am having is that when I use the dll in some project the method’s summaries are not shown even though I have the summaries for the methods in the Class Library project.
Does any one know what would be the problem?
Re: [2005] Method's Summaries?
Are they set up correctly?
What dothey look like?
-tg
1 Attachment(s)
Re: [2005] Method's Summaries?
I think they are setup corectly because if i use the methodes in class library then it shows the summaries but if i use the dll file generated by the class library project in some project it doesn't. Here this is one of the methodes that has the summary (discription) of the method.
Code:
''' <summary>
''' Gets the last Api error message.
''' </summary>
Public Function GetLastApiError() As String
Dim message As String = Nothing
Dim eCode As Integer = Kernel32.GetLastError()
If eCode > 0 Then
Kernel32.FormatMessage( _
Kernel32.FORMAT_MESSAGE_ALLOCATE_BUFFER _
Or Kernel32.FORMAT_MESSAGE_FROM_SYSTEM _
Or Kernel32.FORMAT_MESSAGE_IGNORE_INSERTS, _
0, eCode, Kernel32.LANG_NEUTRAL, message, 0, 0)
End If
Return message
End Function
It spouse to show the summary as in the attached image
Re: [2005] Method's Summaries?
When you use xml comments directly in the code like you have, a separate xml file is created when the project is built. This xml file must be present in the same directory as the library file or the comments will not show (obviously because they cannot be found.)
Re: [2005] Method's Summaries?
Thanks Troy Lundin, that was the case. One more question is there other way to have this comments but not including any file?
Re: [2005] Method's Summaries?
Quote:
is there other way to have this comments but not including any file?
Not to my knowledge. Creating the comments with three single quotes is just a very simple way of making the xml file. It sure is better than making it by hand.
Re: [2005] Method's Summaries?