This project has moved and is read-only. For the latest updates, please go here.

Documenting DBML Auto Generated Classes

Topics: Developer Forum, Project Management Forum, User Forum
Apr 12, 2014 at 12:35 PM
I have a class that is auto generated in the DBML:
Public Class Category
    Public Property CatUID as GUID
    Public Property CatDesc as String
End Class
Can someone please tell me how I can document it? Event through an external XML file, as I did not manage.


Apr 12, 2014 at 7:38 PM
See the Sharing Project Summary and Namespace Comments topic in the SHFB help file. The process will be similar but you'll add comments for the members. The IntelliSense component can be used to generate a blank file to get you started. See the "I have an assembly without code and without an XML comments file for which I'd like to create documentation and/or an Intellisense file. How can I do that?" question in the FAQ topic for more information.

Apr 14, 2014 at 2:27 PM
Can you please reference me to a topic describing the member prefix (eg <member name="N:MyNameSpacve>) cos I cannot find any.
Apr 14, 2014 at 4:14 PM
See the Member ID Strings topic in the XML comments guide.