柚子Nan--回归原点

Everything can be as easy as you like or as complex as you need.
  博客园  :: 首页  :: 新随笔  :: 联系 :: 订阅 订阅  :: 管理

关于NDoc的简单说明和一个疑惑

Posted on 2005-03-18 11:44  柚子Nan  阅读(1240)  评论(3)    收藏  举报

首先非常感谢Allen Lee做出的贡献,让你可以非常迅速的上手NDoc

 

我在使用的时候,遇到了如下一个问题:

NDoc的操作界面中可以设置

CopyrightHref CopyRightText,另外也可以设置FooterHtml的值,我发现这两个数据有冲突,如果仅设置其中的一个是没有问题的。

例如:

CopyrightHref http://www.cnblogs.com/Koffer

CopyRightTextKoSoft Co,Ltd

 

FooterHtml   <br> <br>Koffer Software Company is a great company in the world.

《注:<br>是回车换行》

但是,如果以上两个属性同时设置的话,就只能出现FooterHtml,而上边的Copyright的内容全部丢失。有谁知道为什么

 

感谢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