XML注释-intellisense中未显示异常

本文关键字：显示 异常 注释 -intellisense XML | 更新日期: 2023-09-27 18:22:51

我有一个方法在名称空间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
        }
    }
}

我得到了我的总结与智能，但不是例外。我是否必须使用include并创建一个外部xml注释文件，因为它们位于不同的命名空间下？这两个异常都没有出现在intellisense、mycustomeexception或system.exception.中

谢谢。

XML注释-intellisense中未显示异常

实际上，一旦您键入完整的方法名称，然后用鼠标悬停，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>

希望它能说明你想要什么。

只要用户开始键入方法的名称，就可以显示您想要的任何内容。您只需要在summary标记内部提供。

相关文章：