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

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

Google Instant search

By
Google Instant Search is the worst feature ever!!!. I could not for the life of me find a PERMANENT way to turn it off. Every time I turned it off using different means, it always came back. This is the only link I found useful so far, but the suggestion is not that great. It's OK. http://www.google.com/support/forum/p/Web%20Search/thread?tid=2a8bc9c3770bc11b&hl=en It is so annoying and so intrusive, every time I type a character it interrupts me and then I end up because of the time lag with a different string in the search box than the one I intended to type. Are they hiring a whole new set of STUPID generation at Google. This does not take a rocket scientist to figure out that this feature is useless. Even if they believe that is has some usefulness, let me (the customer, the user) decide. Anyone knows how to turn this stupid feature off?
Post a Comment
Read more

Reduce Windows Folder Size

By
I just realized that my Windows directory has over 34 GB of stuff. What the heck!!! When you have Office, a couple of versions of Visual Studio, and few other Microsoft programs, you basically have already gobbled up about 80 GB of hard disk space. I found this online and found it to be useful and effective. It shaves off about 8 GB of your Windows folder. Still not what I had expected but I can definitely use 8 GB for other important documents. I'm just puzzled at what is Micros soft putting in an Operating system folder? huh? 28 GB of crap? Open a command prompt (make sure you either have Admin privileges). If you do not have Admin privileges, then open the command prompt as Admin. dism /online /cleanup-image /spsuperseded /hidesp
Post a Comment
Read more