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
相关文档:
(一)把文件内容写入Access数据库的OLE对象字段中:
if (File.Exists(txtBrow.Text) != false) // 文本框txtBrow中内容为文件路径及文件名
{
//获取文件后缀
FileInfo p = new FileInfo(txtBrow.Text.Trim());
F_str_Type = ......
已知有一个XML文件(bookstore.xml)如下:
<?xml version="1.0" encoding="gb2312"?>
<bookstore>
<book genre="fantasy" ISBN="2-3631-4">
&n ......
第一种
<%=RetInfo("DB","数据库") %>
<%=RetInfo("YX_UpFile","上传文件") %>
<%=RetfileInfo("Include/", "广告")%>
//从前台调用后台方法
//从前台调用后台的方法..并向其方法传入不同的参数!
第二种
<ItemTemplate >
<%#Ret_stat(Convert.ToInt16(Eval("YX_Stat1")), "热点")%>
......
创建一个Winform用户控件 UserControl1
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Data;
using System.Text;
using System.Windows.Forms;
using System.Runtime.InteropServices;
using System.Reflection;
namespace MyActiveT ......
1. 打开新的窗口并传送参数:
传送参数:
response.write("<script>window.open(’*.aspx?id="+this.DropDownList1.SelectIndex+"&id1="+...+"’)</script>")
接收参数:
string a = Request.QueryString("id");
string b = Request.QueryString("id1");
2.为按钮添加对话框
Button1 ......