zoukankan      html  css  js  c++  java
  • NDoc简介


    1、NDoc的作用
    他可以将我们在代码编写过程中使用///形成的XML的注释,自动形成多种风格的类库文档。这些风格可以是JavaDoc,MSDN-thml,MSDN-chm,XML等。让我们快速拥有专业级的类库API 文档
     
    2、NDoc的获得
    NDoc是一个开源项目,由于MS打算要做类似的东西(sandcastle ),作者放弃了后续的开发,其版本停留在1.3X。MS的sandcastle 还是很不好用,而且目前只有控制台界面。NDoc其下载地址如下:
    http://ndoc.sourceforge.net/
     
    好在有一些好事之徒,继续对它的研究提供了其对.Net 2.0的支持。并且做了汉化其下载地址如下:
    http://www.rainsts.net/article.asp?id=382
     
    3、NDoc1.3.1中文版For .Net 2.0的使用
     
    a、在源代码中加入注释。必须是使用///进行的注释
    b、设置项目输出XML文档及其路径。(必须的)
    c、生成程序集。
    d、打开NDoc,添加要生成文档的程序集。或者添加解决方案程序自动分析出程序集。
    e、选择文档引擎(MSDN,XML.....)
    f、进行一些设置(也可以使用默认的设置)
    g、生成文档
    h、查看效果
     
    4、注意事项
    a、NDoc默认设置对访问控制是public的东东进行处理。我在试验的时候类没有加Public关键字,折腾很久才发现原因。
    b、一定要设置生成XML文档,NDoc依赖这个东西
    c、NDoc的设置项可以进行修改。比如你可以允许Internal的东东被输出。使用 class Customer,这样定义的类就可以有注释。
    d、NDoc还增加了一些自己的标签。比如<example>,举例说明如何使用。
    e、中文的用户指南
    http://www.percyboy.com/w/ndoc/userguide.aspx
     
  • 相关阅读:
    ctypes运用
    win10 下获取不到
    semantic ui加载慢的问题
    python 将图片转换为base64编码转储进数据库
    循环遍历共享文件夹,不需要知道目录深度拷贝上传
    计划和打算
    pyqt按键检测
    python B+数的实现
    JAVA算数运算符
    ASCLL码表
  • 原文地址:https://www.cnblogs.com/hobe/p/698330.html
Copyright © 2011-2022 走看看