为“价值”建立评论网页和“示例” [英] Build comment web pages for "value" and "example"

问题描述

您好，


我使用的是Visual C＃标准版。

我想使用xml评论方法评论我的程序，

我不知道为什么如果我使用值和示例标签，它在html结果中不起作用/显示。

例如我有财产


///< value>这是在描述< / value>

///< example>这是在示例中< / example>

public int一个{

得到{

返回27;

}

}


注意：它适用于备注和摘要标签

任何人都可以帮助我吗？

谢谢

Pujo

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don''t know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

推荐答案

嗨ajikoe，


如果你的vs.net doc生成是最常见的xml doc语法


< summary>

< remarks>


但是如果使用ndoc，则可以放置自己的xml标签。看一下这个。酷工具。

http://ndoc.sourceforge.net/


希望它有所帮助。干杯。

-

问候，

Chua Wen Ching :)

" ajikoe"写道：

Hi ajikoe,

The most common xml doc syntax if you vs.net doc generation is

<summary>
<remarks>

But if you use ndoc, you can place your own xml tags. Check this out. Cool tool.

http://ndoc.sourceforge.net/

Hope it helps. Cheers.
--
Regards,
Chua Wen Ching :)
"ajikoe" wrote:

你好，

我使用的是Visual C＃标准版。
我想用xml评论方法评论我的程序，
我不知道为什么如果我使用值和示例标记，它在html结果中不起作用/显示。
例如我有属性

///< value>这是在描述< / value>
///< example>这是在示例< / example>
public int A {
get {
return 27;
}
}

注意：它适用于备注和摘要标签
任何人都可以帮助我吗？
谢谢
Pujo

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don''t know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

您好，


您是否尝试过使用价值和示例？

它是如何看待HTML格式的？


我不知道它看起来如何导致这个这是我第一次使用XML文档，我只是想知道为什么那些标签（值和示例）不起作用。


真诚的你，

pujo

Chua Wen Ching写道：

Hello,

Have you tried using value and example?
How it looks in HTML format?

I don''t know How it looks like cause this is the first time I use XML documentation, I just want to know why those tag(value and example) is not working.

Sincerely Yours,
pujo
"Chua Wen Ching" wrote:

嗨ajikoe，

如果你的vs.net doc生成最常见的xml doc语法是

< summary> ;
<备注>

但是如果你使用ndoc，你可以放置自己的xml标签。看一下这个。酷工具。

http://ndoc.sourceforge.net/

希望有所帮助。干杯。
-
问候，Chua Wen Ching :)

" ajikoe"写道：

Hi ajikoe,

The most common xml doc syntax if you vs.net doc generation is

<summary>
<remarks>

But if you use ndoc, you can place your own xml tags. Check this out. Cool tool.

http://ndoc.sourceforge.net/

Hope it helps. Cheers.
--
Regards,
Chua Wen Ching :)
"ajikoe" wrote:

你好，

我使用的是Visual C＃标准版。
我想用xml评论方法评论我的程序，
我不知道为什么如果我使用值和示例标记，它在html结果中不起作用/显示。
例如我有属性

///< value>这是在描述< / value>
///< example>这是在示例< / example>
public int A {
get {
return 27;
}
}

注意：它适用于备注和摘要标签
任何人都可以帮助我吗？
谢谢
Pujo

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don''t know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

嗨ajikoe，


根据我的理解，只有2种可用于vs.net xml报告生成的xml元素。试试这个：


假设：


///< summary>

///主条目申请点。

///< / summary>

///< remarks>只是一个示例应用程序！< / remarks>

[STAThread]

static void Main（string [] args）

{

}


1）在VS.NET中，转到Tools，然后选择Build Comments Web Page。


2）将显示Build Comments Web Pages。为您想要的任何特定解决方案选择整个解决方案。


3）使用默认设置，然后按确定。


4）您将看到生成的评论文件。


5）导航树，解决方案 - >项目 - > main（在里面你可以看到摘要和评论）。


无论如何我直到现在知道vs.net 2003< remarks>和< summary>是唯一有效的。


即使你可以< example>那里有xml元素。


如果我错了请纠正我！干杯。

-

问候，

Chua Wen Ching :)

" ajikoe"写道：

Hi ajikoe,

From my understanding, only 2 kind of xml elements that can be used into vs.net xml report generation. Try this:

Assuming:

/// <summary>
/// The main entry point for the application.
/// </summary>
/// <remarks>Just a sample app!</remarks>
[STAThread]
static void Main(string[] args)
{
}

1) Inside VS.NET, go to Tools, then select Build Comments Web Page.

2) The Build Comments Web Pages will appear. Select entire solution for any particular solution you want.

3) Use the default settings, and press Ok.

4) You will see a generated comment file.

5) Navigate the tree, solution -> project -> main (inside you can see the summary and remark).

Anyway I know until now in vs.net 2003 <remarks> and <summary> are the only one that works.

Even though you can <example> xml element in there.

Please correct me if i am wrong! Cheers.
--
Regards,
Chua Wen Ching :)
"ajikoe" wrote:

您好，

您是否尝试过使用价值和示例？
它是如何看待HTML格式的？
我不知道它是什么样子因为这是我第一次使用XML文档，我只是想知道为什么这些标签（值和示例）不起作用。

真诚的，
pujo
Chua Wen Ching写道：

Hello,

Have you tried using value and example?
How it looks in HTML format?

I don''t know How it looks like cause this is the first time I use XML documentation, I just want to know why those tag(value and example) is not working.

Sincerely Yours,
pujo
"Chua Wen Ching" wrote:

嗨ajikoe，

如果你的vs.net doc生成最常见的xml doc语法是

< summary> ;
<备注>

但是如果你使用ndoc，你可以放置自己的xml标签。看一下这个。酷工具。

http://ndoc.sourceforge.net/

希望有所帮助。干杯。
-
问候，Chua Wen Ching :)

" ajikoe"写道：

Hi ajikoe,

The most common xml doc syntax if you vs.net doc generation is

<summary>
<remarks>

But if you use ndoc, you can place your own xml tags. Check this out. Cool tool.

http://ndoc.sourceforge.net/

Hope it helps. Cheers.
--
Regards,
Chua Wen Ching :)
"ajikoe" wrote:

你好，

我使用的是Visual C＃标准版。
我想用xml评论方法评论我的程序，
我不知道为什么如果我使用值和示例标记，它在html结果中不起作用/显示。
例如我有属性

///< value>这是在描述< / value>
///< example>这是在示例< / example>
public int A {
get {
return 27;
}
}

注意：它适用于备注和摘要标签
任何人都可以帮助我吗？
感谢
Pujo

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don''t know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

这篇关于为“价值”建立评论网页和“示例”的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！