VS2005,如何给属性添加注释?


做了一个Dll,给方法增加<summary>,一切正常,VS中也有智能提示,但想给属性添加xml注释时,使用<summary> 没有效果,也提示有误,该用什么?

   另:VS2005 还和 VS2003一样,当做成Dll被引用时,需要将XML文档一起跟着吗?(VS2003 中,如果是在同一项目中,<summary>中的会有智能提示,但如果不在同一项目中,则看不到智能提示)


引用回复


游客

未注册












另:VS2005 还和 VS2003一样,当做成Dll被引用时,需要将XML文档一起跟着吗?(VS2003 中,如果是在同一项目中,<summary>中的会有智能提示,但如果不在同一项目中,则看不到智能提示)


应该可以的 要不你引用system.dll 这些哪里来的智能提示?

------------------------------------

做了一个Dll,给方法增加<summary>,一切正常,VS中也有智能提示,但想给属性添加xml注释时,使用<summary> 没有效果,也提示有误,该用什么?

没有看懂 DLL 属性是一个标准的Class  怎么会没有。?

引用回复




游客

未注册













#3

发表于 2007-5-10 15:36 资料短消息加为好友



VS2005与VS2003一样。也需要添加///<summary>来进行注释。

另,在资源管理器里面,对你的dll(即项目)的属性进行设置。

打开它的属性页,在“生成”页面里面,将“XML文档文件”勾起,并设置相关的文件信息。



另,如果你想要的是在属性页面里面显示它的详细说明的话,在你定义的属性上面加[Description("说明信息"),DefaultValue("默认值信息")]


具体参考System.ComponentModel命名空间里面的Description及DefaultValue等相关的说明信息。

引用回复




游客

未注册













#4

发表于 2007-5-10 15:36 资料短消息加为好友



加上:


/// <summary>

/// 功能描述...

/// </summary>


在项目工程属性里再设置一下就可以啦!


VS2003步骤如下:

项目->属性->配置属性->输出(把 [XML 文档文件(X)] 的路径填上后编译就可以了)...


VS2005步骤如下:

项目->属性->生成->输出(把 [XML 文档文件(X)] 勾上后编译就可以了)...

引用回复




游客

未注册













#5

发表于 2007-5-10 15:36 资料短消息加为好友



如果你做的是[用户控件],想在VS的属性窗口里查看该控件的属性说明的话...


就在 用户控件->自定义属性 的上方加:


[Description("描述信息")]

引用回复




游客

未注册













#6

发表于 2007-5-10 15:36 资料短消息加为好友



属性也是同样可以使用的.比如:

/// <summary>

/// 数据是否有改动

/// </summary>

public bool Modified

{

        get

        {

                return this.m_Modified;

        }

}


如果是显示到属性窗口的,请使用[Description("描述信息")]



//Visual Studio 2005 如何快速添加属性

如果想输入如下所示的属性:


private int myVar;


public int MyProperty

{

get { return myVar; }

set { myVar = value; }

}


在VS2003下添加属性时,很方便地在类视图窗口中选择类后,右键,添加属性就可实现。vs2005 & vs2008 常用技巧_xml然而当我在VS2005下想添加属性时,却怎么也找不到……vs2005 & vs2008 常用技巧_自动生成_02最终花了我很长时间才弄出来,虽没有多大意义,但真的很有技巧性。vs2005 & vs2008 常用技巧_添加属性_03现说明如下:

先输入prop(出现如下界面):


vs2005 & vs2008 常用技巧_xml_04


然后连续按2Tab键,VS2005会自动生成属性框架(自己修改属性的类型和名称就可以用了):

vs2005 & vs2008 常用技巧_属性页_05