docfx를 사용하여 참조 문서를 생성하는 방법 (How to generate documentation with references using docfx)

문제 설명

docfx를 사용하여 참조 문서를 생성하는 방법 (How to generate documentation with references using docfx)

.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를 사용하고 있습니다.

문서에서도 "//"에 주석을 표시할 수 있는 방법이 있습니까?

참조 솔루션

방법 1:

Check the following link: https://dotnet.github.io/docfx/spec/metadata_dotnet_spec.html

The metadata defined for .net include the declarations of:

Namespaces

Types, including class, struct, interface, enum, delegate

Type members, including field, property, method, event

All these are annotated with the /// XML comment. Since this is an api descriptor, it makes sense to include only those

(by Ramakrishna Yelduti、Athanasios Kataras)

참조 문서

1. How to generate documentation with references using docfx (CC BY‑SA 2.5/3.0/4.0)