为氧提供库类的文档存根

本文关键字：文档 存根 | 更新日期: 2023-09-27 18:01:42

我有一些类在我的项目中实现INotifyPropertyChanged。我希望所有的PropertyChanged事件都能够从接口继承文档，但由于接口不是我的项目的一部分，它没有氧分页。

我可以用这个文档获得接口的部分文档，类页面出现，继承图显示了实现它的所有类。但我不能宣布一个事件。是否有一个关键字，我错过了添加事件?

namespace MyNamespace
{
    /**
     * @class INotifyPropertyChanged
     * @brief Interface to allow subscribers to know when the object has been updated.  See <a href="http://msdn.microsoft.com/en-us/library/system.componentmodel.inotifypropertychanged.aspx">MSDN Doc</a>
     * @fn void INotifyPropertyChanged::PropertyChanged(sender, e)
     * @memberof INotifyPropertyChanged
     * @brief Notification that a property of the object has changed.
     * @details the name of the property is in the event arguments
     * Still having trouble documenting the parameters correctly, but this doesn't inherit anyway because it's a function, not an event
     */
}

或者我完全错过了机会，有一些方法可以导入智能感知文档?

为氧提供库类的文档存根

尝试创建INotifyPropertyChanged.cs文件，将文档化的接口声明放在那里，但不要包含在任何项目中进行编译，它应该只由doxygen挑选。

根据doxygen文档，它支持标准的ECMA-334 XML标签，这些标签通常用于注释c#代码，因此不需要使用@class， @brief标签等

相关文章：