vs2010的帮助文档是通过浏览器呈现的,编程过程中F1就可以调用相关函数,属性,字段,特性的帮助,并且VS2010中的XML注释很友好,那么
当自己的类库很多的时候,希望把自己的类库中的代码注释也能生成像。net自带的帮助文件一样,调用自己类库中的函数时直接F1就能访问该函数的帮助或注释信息,一个团队或者企业的代码库帮助文件能放在企业的服务器上,通过vs2010的自带帮助系统进行直接跳转访问,我表达的可能不太清晰,谢谢
public class TestClass
{
/// <summary>
/// The GetZero method.
/// </summary>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// class TestClass
/// {
/// static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
public static int GetZero()
{
return 0;
} /// text for Main
static void Main()
{
}
}
当自己的类库很多的时候,希望把自己的类库中的代码注释也能生成像。net自带的帮助文件一样,调用自己类库中的函数时直接F1就能访问该函数的帮助或注释信息,一个团队或者企业的代码库帮助文件能放在企业的服务器上,通过vs2010的自带帮助系统进行直接跳转访问,我表达的可能不太清晰,谢谢
public class TestClass
{
/// <summary>
/// The GetZero method.
/// </summary>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// class TestClass
/// {
/// static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
public static int GetZero()
{
return 0;
} /// text for Main
static void Main()
{
}
}
拷贝类库的时候,要连xml帮助文件一起拷贝。
http://www.codeproject.com/KB/winhelp/msdnintegrator.aspx
http://msdn.microsoft.com/en-us/library/Aa289161VSHIK可能就包含在SDK下,2003版本也可以下载:
http://www.microsoft.com/downloads/en/details.aspx?FamilyID=CE1B26DC-D6AF-42A1-A9A4-88C4EB456D87
In the Templates pane, click Help Integration Wizard, type TestCollection in the Name box, and click OK.