Skip to main content

Building help Files for your C#/.NET Code

Image
By
1- Set your Project Setting to Generate XML as shown below
2- Follow the instructions on the following link http://www.ewoodruff.us/shfbdocs/Index.aspx?topic=html/8c0c97d0-c968-4c15-9fe9-e8f3a443c50a.htm to download Sandcastle and all of its prerequisites. Mainly, for you, it should boil down to 2 items:

A- Down load the SandCastle SDK http://sandcastle.codeplex.com/
B- Download SandCastle Help file Builder http://shfb.codeplex.com/
Launch the Sandcastle Help file Builder applications. Add your Assemblies using the File Add Assembly menu and then just press the Build button. Note that building help files takes some time to watch for the detailed progress and be patient. The resultant is a .chm file that you can browse through and search through for your code classes/methods/etc.

Comments

  1. Youssef6:20 PM

    Note that when you turn on the XML checkbox in your .csproj file, you may get lots of warnings if you have any public method or member that does not have the ///summary (even if it was empty comment summary)

    ReplyDelete

Post a Comment

Popular posts from this blog

Save All/Format All Documents in Visual Studio

By
Sub FormatAll()    For Each proj As Project In DTE.Solution.Projects      FormatFileRecur(proj.ProjectItems())    Next End Sub Sub FormatFileRecur(ByVal projectItems As EnvDTE.ProjectItems)    For Each pi As EnvDTE.ProjectItem In projectItems      If pi.Collection Is projectItems Then        Dim pi2 As EnvDTE.ProjectItems = pi.ProjectItems        Try          If pi.Name.EndsWith(".cs") Then            If Not (pi.Name.EndsWith("Designer.cs")) Then               If Not pi.IsOpen Then pi.Open(Constants.vsViewKindCode)             pi.Document.Activate()             DTE.ExecuteCommand("Edit.FormatDocum...
Post a Comment
Read more

Track Files in Visual Studio

By
By default, Visual Studio’s Solution Explorer will update its selected item based on the currently active document. This is extremely annoying as it keeps expanding your projects and folders until your solution explorer becomes unmanageable and unusable, unless you collapse all Projects (Only available if you have Visual Studio Power Commands) installed) and even then, after collapsing the entire solution, the saga returns back. Turn off Active tracking 1. Turn your Active tracking off by going to Tools > Options 2. Select “Projects and Solutions” node 3. Uncheck the “Tack Active Item in Solution Explorer” Add a macro to do on-demand tracking 4. Tools > Marcos > Macro Explorer 5. You will see “MyMacros” Module (Node). Right mouse click on MyMacros and invoke “New Module…” 6. Name it anything you like. I Named it Utilities 7. Right mouse click on Utilizes and invoke “new Macro…” menu. The Macros IDE window opens. 8. Paste in the following into it within the Publ...
Post a Comment
Read more