none
为属性添加说明 RRS feed

  • 问题

  • 我自己制作的控件中添加属性DBServerType,我想为其添加说明“AAAAA”,当用户开发过程中调用这个属性的时候,能够看到这个说明,而不是必须去看控件的说明文档,该怎样实现呢?如果DBServerType是方法,又该怎样实现?谢谢!我如下实现效果不对:
           ///   <summary>
            ///   数据库服务器类型:1为SQL Server;2为Oracle 
            ///   </summary>
            public string DBServerType                            
            {
                set { DBServerType = value; }  
            }
    guiwenyang
    2010年3月9日 8:11

答案

  • 我知道怎么做了,谢谢大家,除了添加
    ///   <summary>  
      ///     说明
      ///   </summary>
    这样的说明外,还需要在工程的项目属性中的生成-》输出中选中XML文档文件。
    guiwenyang
    • 已标记为答案 guiwenyang 2010年3月10日 1:28
    2010年3月10日 1:28

全部回复

  • 这么做事不行的,必须依赖标签注入的方式
    你在属性上面加如下代码试试:
    [Category("属性的分类,也就是这个属性应该在vs的哪一组出现")]
    [Description("这里是属性描述")]
    2010年3月9日 8:23
  • "属性的分类"是什么意思,都有哪些值?谢谢!
    guiwenyang
    2010年3月9日 8:25
  • 可以的
    在方法或者属性前面你按三下///就可以了,出现<summary>
    ///   <summary>  
      ///     说明
      ///   </summary>  
      ///   <param   name="args"> 参数说明  </param>   
     
    努力+方法=成功
    2010年3月9日 8:26
  • 比如说你拖一个服务器控件到页面,然后再属性窗口里显示这个控件的属性,你定义的属性应该在哪一组里显示,比如说"外观""行为""其他"等

    抱歉,上面没解释清楚

    2010年3月9日 8:33
  • 出现了,但是调用的使用还是看不到说明
    guiwenyang
    2010年3月9日 8:35
  • 调用时候的说明就是楼上开心所说的那样.

    2010年3月9日 10:22
  • 你好!
         属性一般这样添加注释,你试试看:
        /// <summary>The Name property represents the employee's name.</summary>
        /// <value>The Name property gets/sets the _name data member.</value>
        public string Name
        {
            get
            {
                return _name;
            }
            set
            {
                _name = value;
            }
        }
    

    周雪峰
    2010年3月9日 11:25
    版主
  • 我知道怎么做了,谢谢大家,除了添加
    ///   <summary>  
      ///     说明
      ///   </summary>
    这样的说明外,还需要在工程的项目属性中的生成-》输出中选中XML文档文件。
    guiwenyang
    • 已标记为答案 guiwenyang 2010年3月10日 1:28
    2010年3月10日 1:28
  • 你好!
         属性一般这样添加注释,你试试看:
        /// <summary>The Name property represents the employee's name.</summary>
    
        /// <value>The Name property gets/sets the _name data member.</value>
    
        public string Name
    
        {
    
            get
    
            {
    
                return _name;
    
            }
    
            set
    
            {
    
                _name = value;
    
            }
    
        }
    
    
    
    

    周雪峰




    呵呵,我想楼主的意思是,在添加这样的注释之后,将编译好的DLL,提交给其他开发人员,其他人员如何在开发过程中看到这样的属性帮助说明信息对吧。

    除了添加如各位所说的注释方式以外,还要将编译时声称的XML文件一起提交给其他开发人员,比如你的程序集名称叫做test.dll,那么如果你在工程属性中选择“输出中选择XML文档”,会生成类似下面格式的文档,名字为test.xml。
    <?xml version="1.0"?>
    <doc>
        <assembly>
            <name>DevExpress.Data.v7.2</name>
        </assembly>
            <member name="M:DevExpress.Xpo.DB.SortingColumn.#ctor">
                <summary>
                    <para>Initializes a new <see cref="T:DevExpress.Xpo.DB.SortingColumn"/> class with default settings.
    </para>
                </summary>


            </member>
    </doc>

    将开发成果转交时,除了提交DLL以外,还要将这个Xml文件,一起提交。

    2010年3月10日 2:16