柚子Nan--回归原点

Everything can be as easy as you like or as complex as you need.
posts - 233, comments - 985, trackbacks - 17, articles - 29
  博客园 :: 首页 :: 新随笔 :: 联系 :: 订阅 订阅 :: 管理

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

Posted on 2005-03-18 11:44 柚子Nan 阅读(919) 评论(3)  编辑 收藏 网摘 所属分类: [技术.Net]

首先非常感谢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

Feedback

#1楼 [楼主]   回复  引用  查看    

2005-03-18 13:35 by 柚子Nan      
如何书写Namespace的描述
 

Namespace Summaries

The standard C# documentation tags don't include any way to provide a summary for a namespace. NDoc supports two mechanisms for specifying namespace summaries. One is by supplying them in a special code file within your project. The other is via the project designer.

In the project designer, click the "Namespace Summaries" button and you will be presented with a dialog that allows you to set a namespace summary for each namespace in your project.

These summaries will be included in the compiled documentation。

#2楼    回复  引用  查看    

2005-03-18 16:51 by 不至于      
利率高了,你娃要努力赚钱啊!
那些本来就买不起房的人,巴不得利率加到100%呢
那些贷款才买得起房子的人,巴不得利率为0呢
那些不贷款都买得起房的人,才不管利率呢

#3楼    回复  引用    

2005-03-25 18:08 by T [未注册用户]
如何设置使Private的方法和属性也显示在文档里?

如何设置这样的类的注释显示在文档里:
<Serializable(), _
System.ComponentModel.DesignerCategoryAttribute("code"), _
System.Diagnostics.DebuggerStepThrough(), _
System.ComponentModel.ToolboxItem(true)> _
Public Class TypedSs
Inherits DataSet


<System.ComponentModel.Browsable(false), _
///注释 System.ComponentModel.DesignerSerializationVisibilityAttribute(System.ComponentModel.DesignerSerializationVisibility.Content)> _
Public ReadOnly Property 所属 As 所属DataTable
Get
Return Me.table所属
End Get
End Property

///注释
<System.Diagnostics.DebuggerStepThrough()> _
Public Class AAA

End Class

End Class

谢谢啊




标题  
姓名  
主页
Email (博主才能看到) 
验证码 *  看不清,换一张 [登录][注册]
内容(请不要发表任何与政治相关的内容)  
  登录  使用高级评论  新用户注册  返回页首  恢复上次提交      
该文被作者在 2005-03-18 14:47 编辑过
Google站内搜索

相关文章:

相关链接:

历史上的今天:
2004-03-18 关于UML的几个视图的概念!