c# - 如何使用 docfx 生成带有参考的文档

Question

我正在尝试为 .net 项目（多层）生成文档。但是我无法在使用docfx 生成的文档中看到参考类信息。

例如：

using Microsoft.AspNetCore.Mvc;
using ServiceLayer;

namespace testApplication.Controllers
{
    /// <summary>
    /// Home COntroller
    /// </summary>
    public class HomeController : Controller
    {
        /// <summary>
        /// Index Method
        /// </summary>
        /// <returns></returns>
        public IActionResult Index()
        {
            Class1 cls1 = new Class1();
            //calling testmethod.
            string abc = cls1.testmethod("testing");
            return View();
        }
    }
}

上面的代码引用了ServiceLayer。使用我调用测试方法。但是文档没有显示，这个类正在使用 ServiceLayer Reference。

并且有什么方法可以在文档中的“//”中显示评论

Answer 1

检查以下链接：https ://dotnet.github.io/docfx/spec/metadata_dotnet_spec.html

为 .net 定义的元数据包括以下声明：

命名空间

类型，包括类、结构、接口、枚举、委托

类型成员，包括字段、属性、方法、事件

所有这些都使用///XML 注释进行注释。由于这是一个 api 描述符，因此只包含那些是有意义的