关于NDoc的简单说明和一个疑惑
2005-03-18 11:44
288 查看
首先非常感谢Allen Lee做出的贡献,让你可以非常迅速的上手NDoc。
我在使用的时候,遇到了如下一个问题:
在NDoc的操作界面中可以设置
CopyrightHref 和CopyRightText,另外也可以设置FooterHtml的值,我发现这两个数据有冲突,如果仅设置其中的一个是没有问题的。
例如:
CopyrightHref :http://www.cnblogs.com/Koffer
CopyRightText:KoSoft Co,Ltd
FooterHtml: <br> <br>Koffer Software Company is a great company in the world.
《注:<br>是回车换行》
但是,如果以上两个属性同时设置的话,就只能出现FooterHtml,而上边的Copyright的内容全部丢失。有谁知道为什么[/b]?
感谢NDoc1.3Help File,让我们可以知道有这么多的Tag<event>
<example><exception><exlcude/><include><overloads><param><permission><preliminary>
<remarks><returns><seealso><summary><threadsafety><value>
对于每一个Tag如何使用,NDoc1.3Help File都有详细的例子。
特别说说preliminary,这个Tag,用来说明这个方法或者属性是临时的,在生成的Help文件中会以红色标注。例如 [This is preliminary documentation and subject to change.]
这个tag不是必须的,可以在工具NDoc中选择是否生成默认的。
每个tag可以在那些地方使用?NDoc1.3Help File想得非常周到,有个矩阵图:Tag Usage Matrix,可以参考!
其实,最值得提的是NDoc的 Known Issues and Limitations in NDoc 1.3,有如下5个:
l Very long type names
l Case-sensitivity
l StrongNameIdentityPermissionAttribute
l Compact Framework incompatibilities
l Compact Framework incompatibilities
我在使用的时候,遇到了如下一个问题:
在NDoc的操作界面中可以设置
CopyrightHref 和CopyRightText,另外也可以设置FooterHtml的值,我发现这两个数据有冲突,如果仅设置其中的一个是没有问题的。
例如:
CopyrightHref :http://www.cnblogs.com/Koffer
CopyRightText:KoSoft Co,Ltd
FooterHtml: <br> <br>Koffer Software Company is a great company in the world.
《注:<br>是回车换行》
但是,如果以上两个属性同时设置的话,就只能出现FooterHtml,而上边的Copyright的内容全部丢失。有谁知道为什么[/b]?
感谢NDoc1.3Help File,让我们可以知道有这么多的Tag<event>
<example><exception><exlcude/><include><overloads><param><permission><preliminary>
<remarks><returns><seealso><summary><threadsafety><value>
对于每一个Tag如何使用,NDoc1.3Help File都有详细的例子。
特别说说preliminary,这个Tag,用来说明这个方法或者属性是临时的,在生成的Help文件中会以红色标注。例如 [This is preliminary documentation and subject to change.]
这个tag不是必须的,可以在工具NDoc中选择是否生成默认的。
每个tag可以在那些地方使用?NDoc1.3Help File想得非常周到,有个矩阵图:Tag Usage Matrix,可以参考!
其实,最值得提的是NDoc的 Known Issues and Limitations in NDoc 1.3,有如下5个:
l Very long type names
l Case-sensitivity
l StrongNameIdentityPermissionAttribute
l Compact Framework incompatibilities
l Compact Framework incompatibilities
相关文章推荐
- 进程与线程的一个简单解释(目前看到的关于进程和线程说明最好的博文)
- 第三天 简单的一个程序剖析,关键字,关于变量,常量,标识符,
- 关于S5PV210的启动问题和u-boot分析并自己实现一个简单的boot(一)
- 关于后续的一些说明及简单的工具使用
- 一个关于linux socket的简单例子
- 关于虚函数和 Qt 的 Event 函数的简单说明
- 关于fgets()函数的一个简单问题
- 一个简单的关于权限判断登陆的javaBean文件
- shuffle一个简单的过程叙述性说明
- 关于hook设置函数如何支持多核CPU的一个说明
- 关于C#泛型作用的简单说明
- 一个最简单的例子,清楚说明回调函数的作用和强大功能
- 关于一个asp的简单聊天室的代码问题
- 关于 数据源 导出excel (这是) 通过 画一个html 实现的、最简单、好理解、的代码、
- 关于DIP,IoC,DI,以及IoC容器的一个说明
- 简单的一个小体验关于div居中
- 一个关于linux socket的简单例子
- 一个WinForm程序配置信息的简单模型和维护工具——使用说明
- [转载]关于 Debian 源的一些简单说明
- 本程序说明了如何建立一个简单的可以接收UDP服务器数据的UDP客户端