想要使用C#2.0:命名空间文档 [英] Wanted in C# 2.0: Namespace documentation

查看:73
本文介绍了想要使用C#2.0:命名空间文档的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

命名空间没有< summary>文件(是吗?),我认为它是好的。/ b $ b很高兴拥有它。例如,


///< summary>

///包含数学函数的类。

///< ; / summary>

名称空间BillyBob.Math {

...

}


现在如果您有多个< summary>使用命名空间编译,例如

有两个类文件,每个文件都有不同的< summary>对于其他相同的命名空间,然后消费者可以循环浏览

不同的摘要描述......它应该是一系列描述。


我想可能会有点混乱,但它比

所有的描述更好。


有时人们在最奇怪的名字空间中提供东西...


Jon

Namespaces don''t have <summary> documentation (do they?), and I think it
would be nice to have it. For instance,

/// <summary>
/// Classes containing math functions.
/// </summary>
namespace BillyBob.Math {
...
}

Now if you had more than one <summary> compiled with a namespace, such as
having two class files each with a different <summary> for its otherwise
identical namespace, then the consumer could be able to cycle through the
different summary descriptions... it should be an array of descriptions.

Might be a little messy I suppose, but it''s better than no descriptions at
all.

Sometimes people deliver things in the strangest namespaces ...

Jon

推荐答案

2004年5月18日星期二23 :16:09-0700,Jon Davis

< jo*@REMOVE.ME.jondavis.net>写道:
On Tue, 18 May 2004 23:16:09 -0700, "Jon Davis"
<jo*@REMOVE.ME.jondavis.net> wrote:
命名空间没有< summary>文件(是吗?),我认为它很好。拥有它。
Namespaces don''t have <summary> documentation (do they?), and I think it
would be nice to have it.




同意。它们不存在的标准借口是,

名称空间声明通常出现在许多不同的文件中,因此编译器可能会被多个摘要标记混淆。


就个人而言,我认为通过简单地获取找到的

最后一个摘要标记来解决这个问题很简单,并且在发出

警告。程序员只负责使用一个标签。

-
http://www.kynosarges.de


" Christoph Nahr" < CH ************ @ kynosarges.de>写在

新闻:lb ******************************** @ 4ax.com。 ..
"Christoph Nahr" <ch************@kynosarges.de> wrote in
news:lb********************************@4ax.com...
2004年5月18日星期二23:16:09 -0700,Jon Davis
< jo*@REMOVE.ME.jondavis.net>写道:
On Tue, 18 May 2004 23:16:09 -0700, "Jon Davis"
<jo*@REMOVE.ME.jondavis.net> wrote:
命名空间没有< summary>文件(是吗?),我认为它很好。拥有它。
Namespaces don''t have <summary> documentation (do they?), and I think it
would be nice to have it.



同意。它们不存在的标准借口是,
名称空间声明通常出现在许多不同的文件中,因此编译器可能会被多个摘要标记混淆。



Agreed. The standard excuse why they don''t exist yet is that a
namespace declaration typically appears in many different files, so
the compiler might get confused by multiple summary tags.




我读过课可以分布在C#2的多个文件中 -

不会导致完全相同的混乱吗?


Niki



I''ve read that classes could be spread over multiple files in C# 2 -
wouldn''t that cause exactly the same confusion?

Niki


2004年5月19日星期三10:00:48 +0200,Niki Estner

< ; NI ********* @ cube.net>写道:
On Wed, 19 May 2004 10:00:48 +0200, "Niki Estner"
<ni*********@cube.net> wrote:
我已经读过,类可以分布在C#2中的多个文件中 -
不会导致完全相同的混淆吗?
I''ve read that classes could be spread over multiple files in C# 2 -
wouldn''t that cause exactly the same confusion?




是的,它会的。我不知道这个案例的建议解决方案

是 - 也许在主类文件之间存在区别。和

延续类文件,只有主文件可以有注释?

-
http://www.kynosarges.de


这篇关于想要使用C#2.0:命名空间文档的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆