필자는 백서를 작성 중이며 정의의 선언 이전에 주석 블록으로 넣은 내부 문서의 공식 용어가 무엇인지 확신 할 수 없다는 것을 알고 있습니다.메소드 선언 바로 위에있는 문서의 올바른 용어는 무엇입니까?
결국 JavaDoc 회원 문서와 동일한 내용입니다.
단순히 내부 문서가 아니며 "헤더 문서"가 좋은 용어가 될지 잘 모르겠습니다. 그것은 종종 전문적으로 "요구 사항 절"또는 "보험 조항이라 것
이것은 방법 사양 또는 절차 사양이라고합니다. 즉, 구현 세부 사항이 아닌 프로 시저의 동작을 지정합니다. 일부 텍스트 북은이를 메소드의 계약이라고하지만 다소 모호 할 수 있습니다.
(예를 들어, 자바/펄) 특정 언어에 국한되지 하나의 I는 일반적인 용어를 찾고 있어요
주, ".
우리 조직에서는이를 메소드 또는 함수 doc-comment라고 부릅니다. 함수 수준의 문서가 더 널리 사용되는 용어 일 것입니다.
나는 그것을 클래스 또는 파일 주석과 구별하기 위해 항상 메소드 (또는 함수) 주석이라고 부른다.
나는 이것을 코드 주석이라고 부른다.
일반적으로이를 "인라인 문서"라고합니다. 그게 바로 그게 무엇인지에 대한 것입니다. 문서가 이고 소스 코드가이므로 문서가 코드와 동기화 될 가능성이 더 많습니다.
(이것은 물론, 보장은 없지만, 자신의 야채를 먹고 프로그래머를 장려 않습니다. 그것은 개발자가 같은 장소에서 같은 시간 및 에 행동 변화를 문서 을 변경할 수 있습니다 의미보다는 사실 이후 다른 장소에서)