This project has moved. For the latest updates, please go here.

Documenting a shared constructor

Topics: Developer Forum, User Forum
Sep 1, 2008 at 1:38 PM

I have a control that has a constructor declared this way:

Shared Sub New()
End Sub

Though I write <summary> tags for this constructor, SHFB does not show it when the help is compiled. If I remove the Shared word the documentation is shown ok. I read the properties of the project but could not find anything directly related to this behaviour.

How should I document Shared constructors?

Sep 1, 2008 at 4:37 PM
Static constructors are private.  SHFB doesn't document private members by default.  If you want private members documented, you need to set the DocumentPrivates project property to true.  Note that this will include a lot of other stuff that you may not want documented as well.  You can use the other visibility properties to control what appears along with the API filter.