C# CHM帮助文档生成工具
C# CHM帮助文档生成工具-Sandcastle
为了让我们的开发团队规范文档,并易于交流,最终使用了Sandcastle生成chm格式文档。
一、下载。
我发现有两种Sandcastle可供下载,一个是官方的Sandcastle,另一个是SandcastleGUI(图形界面的)。
前一个是必须安装的,然后再下载个SandcastleGUI,直接使用即可,下载地址为:
Sandcastle: http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en (也可以从codeplex下载)
SandcastleGUI:虽然安装完上面的Sandcastle里已经有一个SandcastleGUI了,但是不如这个SandcastleGUI,这是一个inchl software开发的图形界面Sandcastle,非常好用
下载地址是 http://www.inchl.net/SandcastleGUI/ 需要注意的是他不提供直接下载功能,而是通过邮件确认后方可下载。
这里有使用SandcastleGUI生成的文档和软件界面,是不是很漂亮?
二、生成XML文档。
在VS的项目上右键->属性,在弹出的对话框里选择Build,在XML Documentation前打勾。这样,以后编译的程序都会自带一个XML文件了,这就是要生成帮助文档的重要文件。
三、在程序里添加说明。添加方法如下:
namespace DangAnGuanLi.LogSystem
{
/// <summary>
/// Log相关操作集,此Log通过log4net实现。
/// <remarks>类图如下: <br />
/// <img src="LogHelper.png" />
/// </remarks>
/// </summary>
public class LogHelper
{
/// <summary>
/// 创建loginfo型的log类型
/// </summary>
public static readonly log4net.ILog loginfo = log4net.LogManager.GetLogger("loginfo");
/// <summary>
/// 没实现
/// </summary>
private static void SystemLog()
{
}
/// <summary>
/// log4net的初始设置
/// </summary>
public
相关文档:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Xml;
namespace WebApplication2
{
/// <summary>
/// XMLHelper XML文档操作管理器
&nb ......
//命名空间 using Microsoft.Win32;
private void checkBox2_CheckedChanged(object sender, System.EventArgs e)
{
if (checkBox2.Checked) //设置开机自启动
{
//MessageBox.Show ("设置开机自启动需要修改注册表","提示");
string path = Application.ExecutablePath;
RegistryKey rk = Registry.LocalMac ......
源码如下:
using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using System.Diagnostics;
using System.Runtime.InteropServices;
using System.IO;
using Microsoft.Win32;
namespace mv
{
......
http://www.tangiblesoftwaresolutions.com/Product_Details/Instant_CSharp.html
http://www.tangiblesoftwaresolutions.com/?gclid=COeGzKKxo58CFQIupAodu2jvJQ
在线
VB.net和C#在线互转工具
http://bbs.51aspx.com/showtopic-2059.html
Convert VB.NET to C#
http://www.developerfusion.com/tools/convert/vb-to- ......