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

WCF Dos and Don'ts

By
Do not inherit interfaces from other interfaces. Interfaces are contracts. Contracts must be explicit, otherwise the flexibility and maintainability of your design would run into issues. An interface is a pure contract definition and should remain explicit and pure. Consider the following example: [ServiceContract] public interface IMyService1 { [OperationContract] void Test1(); } [ServiceContract] public interface IMyService2 : IMyService1 { [OperationContract] void Test2(); } [ServiceBehavior(…)] class MyService : IMyService2, IMyService1 { #region IMyService2 Members public void Test2() { } #endregion #region IMyService1 Members public void Test1() { } #endregion } What happens when you Publish your Service and open its communication channels. If you do the following: ServiceHost serviceHost = new ServiceHost(typeof(MyService, …) ServiceEndpoint ep = serviceHost.AddServiceEndpoint(typeof(IMyService1), typeof(IMyService2)); You will get
Post a Comment
Read more

How to turn off the annoying adobe updater

By
Mainly for peole who only installed adobe reader, this becomes an annoying intrusive behavior. Who cares about the updated version of Adobe. 1- Run Adobe Reader 2- Invoke the "Edit" > "Preferences" menu 3- Select the Updater node at the bottom. 4- Select the "Do not download or install updates automatically" 5- Press OK. Done!!!!!!!!!!!! Phew
Post a Comment
Read more

TF31001 error when connecting to TFS 2010

By
The Server returned the following error: 246021. An error occurred while processing your request. Technical Information (for Administrator): SQL Server Error 1934 (retry) This error is caused due to SQL Server Server settings of "noCount" and/or "numeric round about" being turned on. Run ssms.exe, right click on the SQl Server node, and invoke the Proerties dialog. Select the "Connections" node, and turn off both items.
Post a Comment
Read more