我遵循这个为类库创建了一个API文档。
在类库的注释中,我使用了“请参阅”标记来引用其他类型。
例如,这是包含System.Action扩展方法的类的注释
/// <summary>
/// Class containing some extension methods for <see cref="Action" />.
/// </summary>
public static partial class ActionEx
docfx为上面的注释创建以下YAML源:
summary: "\n Class contain
我的项目中有一些事件处理程序委托,我希望将它们包含在使用docfx自动生成的文档中。 我知道在docfx.json > metadata中有一个过滤器选项,但是我如何配置它呢?有什么想法吗? 我已经尝试添加一个filterConfig.yml,并修改docfx.json,没有任何错误,但这不起作用。 C#代码: /// <summary>
/// Double click on one row of the search result, this should open the detail form of it
/// </summary>
/// <p
我正在寻找C#的XML源代码文档的替代方案,它是由XML的本质引入的,大量的噪音让人眼花缭乱,需要编写更多的工作:
/// <summary>
/// This is text of importance. Linking to
/// <see cref="AnotherClass>is somewhat verbose.</see>
/// </summary>
/// <param name="andSo">is parameter documentation</param>
相反,我想在文档