如何使用 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。 使用它，我正在調用 testmethod。 但是文檔沒有顯示，這個類正在使用 ServiceLayer 引用。

有什么方法可以在文檔中也顯示“//”中的注釋

Answer 1

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

為 .net 定義的元數據包括以下聲明：

命名空間

類型，包括類、結構、接口、枚舉、委托

類型成員，包括字段、屬性、方法、事件

所有這些都使用/// XML 注釋進行注釋。 由於這是一個 api 描述符，因此只包含那些是有意義的