Public 멤버 함수
	DocumentationCatalogService (IWebHostEnvironment environment)
IReadOnlyList< DocumentationProjectInfo >	GetProjects ()

Private 속성
readonly IWebHostEnvironment	_environment
IReadOnlyList< DocumentationProjectInfo >?	_projects

상세한 설명

생성된 프로젝트 문서 카탈로그를 웹 루트에서 읽어 제공합니다.

DocumentationCatalogService.cs 파일의 16 번째 라인에서 정의되었습니다.

생성자 & 소멸자 문서화

◆ DocumentationCatalogService()

DreamineWeb.Services.DocumentationCatalogService.DocumentationCatalogService ( IWebHostEnvironment environment )

inline

문서 카탈로그 서비스를 초기화합니다.

매개변수

environment 웹 루트 경로를 제공하는 호스팅 환경입니다.

예외

ArgumentNullException environment 가 null인 경우 발생합니다.

DocumentationCatalogService.cs 파일의 62 번째 라인에서 정의되었습니다.

    {
        _environment = environment ?? throw new ArgumentNullException(nameof(environment));
    }

다음을 참조함 : _environment.

멤버 함수 문서화

◆ GetProjects()

IReadOnlyList< DocumentationProjectInfo > DreamineWeb.Services.DocumentationCatalogService.GetProjects ( )

inline

생성된 프로젝트 문서 목록을 읽어 반환합니다.

반환값: 이름순으로 정렬된 프로젝트 문서 목록입니다.

예외

FileNotFoundException 지식 그래프 게시 스크립트가 아직 카탈로그를 생성하지 않은 경우 발생합니다.

DocumentationCatalogService.cs 파일의 91 번째 라인에서 정의되었습니다.

    {
        if (_projects is not null)
            return _projects;
 
        string catalogPath = Path.Combine(_environment.WebRootPath, "understand", "project-catalog.json");
        if (!File.Exists(catalogPath))
            throw new FileNotFoundException("Project documentation catalog was not generated. Run Publish-UnderstandDashboard.ps1.", catalogPath);
 
        using FileStream stream = File.OpenRead(catalogPath);
        DocumentationProjectCatalog catalog = JsonSerializer.Deserialize<DocumentationProjectCatalog>(stream, new JsonSerializerOptions
        {
            PropertyNameCaseInsensitive = true
        }) ?? new DocumentationProjectCatalog();
        _projects = catalog.Projects.OrderBy(project => project.Category).ThenBy(project => project.Name).ToArray();
        return _projects;
    }

다음을 참조함 : _environment, _projects, DreamineWeb.Models.DocumentationProjectCatalog.Projects.

멤버 데이터 문서화

◆ _environment

readonly IWebHostEnvironment DreamineWeb.Services.DocumentationCatalogService._environment

private

카탈로그 파일이 위치한 웹 호스팅 환경입니다.

DocumentationCatalogService.cs 파일의 26 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : DocumentationCatalogService(), GetProjects().

◆ _projects

IReadOnlyList<DocumentationProjectInfo>? DreamineWeb.Services.DocumentationCatalogService._projects

private

처음 읽은 뒤 재사용하는 프로젝트 문서 목록입니다.

DocumentationCatalogService.cs 파일의 36 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : GetProjects().

이 클래스에 대한 문서화 페이지는 다음의 파일로부터 생성되었습니다.:

DocumentationCatalogService.cs

Public 멤버 함수

Private 속성