Dartdoc: 명시적 라이브러리 태그 없이 라이브러리 수준 API 문서를 생성할 수 있는 기능이 필요합니다.

dartdoc은 분석기에서 모든 요소에 대한 문서 주석을 가져옵니다. 따라서 첫 번째 선언 전에 다트 파일에서 문서 주석을 가져오는 것을 지원하도록 분석기를 수정해야 합니다.

@Sfshaza , 분석기에 대한 문제를 열고 여기에 연결할 수 있습니까? 감사 해요!

https://github.com/dart-lang/analyzer_cli/issues/81

약간의 토론 후에 새로운 제안된 규칙은 더 간단합니다.

모든 지시문(가져오기, 내보내기 등)에 첨부된 첫 번째 문서 주석을 사용하십시오.

이 수정 사항은 분석기에 적용되었습니다. 새 분석기 패키지(현재 0.27.1+2)로 업그레이드하면 이 문제가 해결됩니다.

이거 고쳐진거 같은데?

수정된 적이 있는지 모르겠습니다.

가져오기 위에 라이브러리 문( library stagehand; )을 추가하지 않는 한 무대 문서에 대한 라이브러리 주석이 표시되지 않습니다. https://github.com/dart-lang/stagehand/pull/307 (3/2016), v1.0.2에서 library 문을 제거했으며, 이때 라이브러리 주석이 dartdoc: 1.0 에서 사라졌습니다. 1.0.1 라이브러리 문서

당신 말이 맞아, 우리는 여전히 라이브러리 성명을 필요로 한다 -- 만약 그것이 한 시점에서 수정되었다면, 그것은 내가 인수하기 전이었다.

그리고 저는 사실 전혀 옳지 않습니다. 이것은 놀랍게도 dartdoc의 내부 테스트에서 작동합니다. 귀하의 경우에 작동하지 않는 이유를 모르면 약간의 조사가 필요합니다.

아주 이상한. 조사해 주셔서 감사합니다. 제가 도울 수 있는 일이 있으면 알려주세요.

업데이트가 있습니까?

AFAIK 상태는 변경되지 않았습니다.

나는 우리가 이것을 원한다고 생각합니다: https://github.com/dart-lang/language/issues/1073

@kevmoo 라이브러리에 대한 문서를 인식하고 생성한다는

@kevmoo 라이브러리에 대한 문서를 인식하고 생성한다는

예. 그러나 많은 사람들이 라이브러리 이름을 지정하는 데 차단되어 있습니다. "벌거벗은" 상태로 물건을 걸 수 있는 장소가 있다면 좋을 것입니다.

dartdoc 및 테스트와 같은 항목에 대한 추측 감소

@kevmoo dart-lang/language#1073에서 제안된 솔루션(이름이 없는 라이브러리 태그가 있음, 예: library; )은 이것이 해결되기를 정말로 선호하는 방식입니다. 물론 그것은 나에게 더 적은 작업을 의미하지만 더 심각하게는 파일 헤더의 주석을 실수로 변경하여 해키 매핑을 깨는 측면에서 훨씬 덜 "흐릿"하고 실패하기 쉽습니다. 이것이 큰 영향을 미친다는 데이터가 있거나 중요한 사용자가 차단되어 언어 솔루션을 기다릴 수 없는 경우 P1으로 업그레이드합니다.

라이브러리 문을 포함하지 않으면 라이브러리는 암시적으로 파일 이름으로 명명됩니다. 맞죠? main.dart 에는 암시적 library main 있습니다. 그렇다면 "빈" 라이브러리 명령문이 동일한 작업을 수행할 수 없는 이유는 무엇입니까?

@Levi-Lesches 언어 외에는 이름이 없는 library; 문을 지원해야 하는 것 외에는 특별한 이유가 없습니다.

예, 전적으로 동의합니다. library; 명령문이 수행되기를 기대하는 것입니까? 없는 것과 같습니까?

예, 전적으로 동의합니다. library; 명령문이 수행되기를 기대하는 것입니까? 없는 것과 같습니까?

내 관점에서는 라이브러리 이름에 대해 생각할 필요 없이 "부동" 주석을 허용하는 해킹을 제거합니다.

@Levi-Lesches 꽤 많이. 유일한 차이점은 분석기가 주석뿐만 아니라 해당 명령문에 대한 문서도 연결할 수 있으므로 dartdoc과 같은 다운스트림 도구 소비자에 대해 LibraryElement 를 반환할 수 있다는 것입니다.

library; 선언은 주석과 dartdoc을 걸 수 있다는 점을 제외하고 라이브러리 선언이 없는 것과 똑같은 일을 합니다. library foo.bar.baz; 와 같이 라이브러리 자체를 나타내는 선언이지만 후자와 달리 라이브러리 이름 도 지정하지 않습니다.

라이브러리 선언이 없는 라이브러리는 빈 이름을 가지며 library; 도 라이브러리에 빈 이름을 제공합니다.