XML注释 - 智能感知中未显示的例外情况

时间:2015-11-19 20:30:33

标签: c# visual-studio intellisense xml-comments

我有一个在命名空间下抛出异常的方法:MyApp.Domain。我在命名空间下有一些自定义异常:MyApp.Domain.Exceptions。所以我拥有的是:

using MyApp.Domain.Exceptions
using System;

namespace MyApp.Domain
{
    public class SomeClass
    {
        ///<summary>This method does some stuff</summary>
        ///<exception cref="MyCustomExeption">MyCustomException if x</exception>
        ///<exception cref="Exception">GenericException if y</exception>
        public void DoStuff(){

            //Does stuff

        }
    }
}

我使用intellisense获取我的摘要但不是例外。我是否必须使用include并创建外部xml注释文件,因为它们位于不同的命名空间下?这两个例外都没有出现在intellisense,mycustomexception或system.exception中。

谢谢。

1 个答案:

答案 0 :(得分:4)

实际上,只要您在鼠标悬停时输入完整的方法名称,Exception标记就会显示。

如果您想在开始输入方法名称后立即显示异常,则必须在摘要标记中提供由<para>分隔的异常

     /// <summary>
    /// this is my method for date convert        
    /// <para>Exception:</para>
    /// Exception - this will appear as soon as you started typing the method name and method over.
    /// </summary>
    /// <exception cref="Exception"></exception> 
希望它能说明你想要的东西。

在用户开始输入方法名称时显示任何您想要的内容。您只需在摘要标记内提供。