VS生成chm帮助文档

VS代码中使用Xml注释,并通过Sandcastle生成chm文档的文章,这几篇值得分享:

VS的XML注释语法:

微软的建议

建议的文档注释标记(C# 编程指南)

标记

注释示例

请重点看下面方法的xml注释:

/// <summary>

        ///     根据用户Id得到用户名.

        ///     <para>

        ///         此处添加第二段Summary信息,在MSDN中很少使用.所以不推荐使用.

        ///     </para>  

        /// </summary>

        /// <remarks>

        ///     如果没有找到用户则返回null.<br/>

        ///     <paramref name="userId"/> 参数为正整数.<br/>

        ///     用户Id模型属性定义参见<see cref="UserInfo.UserId"/><br/>

        ///     相关方法:<seealso cref="UserBL.GetUserId"/>

        /// </remarks>

        /// <param name="userId">用户Id</param>

        /// <returns>用户真实姓名</returns>

        /// <example>

        ///     返回用户id为100的用户真实姓名:

        ///     <code>

        ///         private string userName = string.Empty;

        ///         userName = UserBL.GetUserName(100);

        ///     </code>

        ///     返回的用户名可能为null,使用时要先判断:<br/>

        ///     <c>if(userName!=null){...}</c>

        /// </example>

        /// <exception cref="System.ApplicationException">

        ///     如果用户Id小于0则抛出此异常

        /// </exception>

        public static string GetUserName(long userId)

        {

            string result = string.Empty;

            if (userId < 0)

            {

                throw new System.ApplicationException();

            }

            else if (userId == 0)

            {

                result = null;

            }

            else

            {

                result = "Robert";

            }

            return result;

        }

生成chm文档后的截图

文档摘要

文档详细信息

为Unity项目生成文档(一)的更多相关文章

  1. 为Unity项目生成文档(二)

    Unity项目生成文档 接着上篇文章:为Unity项目生成文档(一) .Net项目可在VS配置XML 我们可以在VS中通过配置来生成xml文件,但是unity的project,就算同样配置了xml文档 ...

  2. 使用swagger在netcorewebapi项目中自动生成文档

    一.背景 随着前后端分离模式大行其道,我们需要将后端接口撰写成文档提供给前端,前端可以查看我们的接口,并测试,提高我们的开发效率,减少无效的沟通.在此情况下,通过代码自动生成文档,这种需求应运而生,s ...

  3. 使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档(ASP.NET Core Web API 自动生成文档)

    对于开发人员来说,构建一个消费应用程序时去了解各种各样的 API 是一个巨大的挑战.在你的 Web API 项目中使用 Swagger 的 .NET Core 封装 Swashbuckle 可以帮助你 ...

  4. 使用Ldoc给Lua生成文档

    Ldoc介绍 LDoc是一个Lua的文档生成工具,过去,比较常用的Lua生成文档的工具是LuaDoc,可惜作者自从2008年之后就再也没有发布过新的版本了,说明作者基本上已经放弃维护了.而LDoc则是 ...

  5. 配置WCF同时支持WSDL和REST,swaggerwcf生成文档

    配置WCF同时支持WSDL和REST,SwaggerWCF生成文档 VS创建一个WCF工程,通过NuGet添加SwaggerWcf 创建完成后通过 程序包管理控制台 pm>Install-Pac ...

  6. ASP.NET Core 1.0 中使用 Swagger 生成文档

    github:https://github.com/domaindrivendev/Ahoy 之前文章有介绍在ASP.NET WebAPI 中使用Swagger生成文档,ASP.NET Core 1. ...

  7. 使用eclipse生成文档(javadoc)

    使用eclipse生成文档(javadoc)主要有三种方法:1,在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步.在Java ...

  8. xcode 自动添加注释,生成文档

    一.自动生成注释代码        添加一个快捷键,生成 注释代码        ThisService 下载连接:http://wafflesoftware.net/thisservice/     ...

  9. MVC WEB api 自动生成文档

    最近在一直在用webapi做接口给移动端用.但是让我纠结的时候每次新加接口或者改动接口的时候,就需要重新修改文档这让我很是苦恼.无意中发现.webapi居然有自动生成文档的功能....真是看见了救星啊 ...

随机推荐

  1. linux tcp/ip编程和windows tcp/ip编程差别以及windows socket编程详解

    最近要涉及对接现有应用visual c++开发的tcp客户端,花时间了解了下windows下tcp开发和linux的差别,从开发的角度而言,最大的差别是头文件(早期为了推广尽可能兼容,后面越来越扩展, ...

  2. HTML5&CSS3经典动态表单-2

    上一个demo效果没出来!实际如下 代码没问题.不知道为啥,展示的demo里光标获取焦点的时候不会有如下效果

  3. andriod 获取电池的信息

    <?xml version="1.0"?> <LinearLayout android:orientation="vertical" andr ...

  4. Oracle LPAD/RPAD函数在处理中文时的注意事项

    首先看下Oracle官方对函数的定义: The RPAD function returns an expression, right-padded to a specified length with ...

  5. Servlet开发配置

    本文主要简单实践一下servlet开发相关开发 1.Servlet的创建 两种方法: 创建普通的java类,继承自HttpServlet类,在通过手动配置web.xml文件注册Servlet对象,比较 ...

  6. hadoop2.6完全分布式安装HBase1.1

    本文出自:http://wuyudong.com/archives/119 对于全分布式的HBase安装,需要通过hbase-site.xml文档来配置本机的HBase特性,由于各个HBase之间通过 ...

  7. XCode中#pragma的使用

    为了能够快速定位到代码的目标位置,可以使用#pragma:  

  8. linux---文本编辑vi

    本文摘自:鸟哥的linux私房菜

  9. android activity 管理器AMS----概述

    AMS & WMS,应该是app端打交道最多的2个framwork层的service. ActivityManagerService 是android提供给用于管理Activity运行状态的系 ...

  10. Flash网站Loading制作

    Flash网站Loading制作~~~ stop(); stage.scaleMode=StageScaleMode.NO_SCALE; //指定舞台属性为不跟随播放器大小而改变 stage.show ...