Как сгенерировать документацию со ссылками, используя 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 Reference.

и есть ли способ показать комментарии в "//" также в документации

Answer 1

Проверьте следующую ссылку: https://dotnet.github.io/docfx/spec/metadata_dotnet_spec.html

Метаданные, определенные для. net, включают объявления:

Пространства имен

Типы, включая класс, структуру, интерфейс, перечисление, делегат

Типы членов, включая поле, свойство, метод, событие

Все они помечены /// XML комментарий. Поскольку это дескриптор API, имеет смысл включать только те