메소드 선언 바로 위에 놓은 문서의 올바른 용어는 무엇입니까?

Question

나는 백서를 쓰고 있으며 정의 선언 전에 의견 블록으로 넣은 내부 문서의 종류에 대한 공식 용어가 무엇인지 확실하지 않다는 것을 깨달았습니다.

결국 Javadoc 회원 문서가되는 것과 동일합니다.

그것은 단순히 내부 문서화가 아니며 "헤더 문서"가 좋은 용어인지 확실하지 않습니다.

특정 언어에 특정한 것이 아니라 일반적인 용어를 찾고 있습니다 (예 : Java/Perl).

Answer 1

이것을 a라고합니다 메소드 사양 또는 절차 사양. 즉, 구현 세부 사항보다는 절차의 동작을 지정합니다. 일부 교과서는이를 방법의 계약이라고하지만 약간 모호 할 수 있습니다.

Answer 2

내 조직에서 우리는 그것을 방법 또는 기능 Doc-Comment라고 부릅니다. 기능 수준 문서는 아마도 널리 사용되는 용어 일 것입니다.

Answer 3

나는 항상 그것을 메소드 (또는 함수) 주석이라고 부르며 클래스 또는 파일 주석과 구별됩니다.

Answer 4

종종 전문적으로 "요구 사항 조항"또는 "보험 조항"이라고합니다.

Answer 5

나는 보통 그것을 "인라인 문서"라고합니다. 나에게 그것은 그것이 무엇인지에 관한 것입니다 - 당신의 문서는 안에 소스 코드이므로 문서가 코드와 동기화 될 가능성이 더 높습니다.

(물론 이것은 보장은 아니지만 프로그래머가 야채를 먹도록 권장합니다. 이는 개발자가 문서를 변경할 수 있음을 의미합니다. 동시에 그리고 같은 장소에서 행동은 사실 이후와 다른 곳에서 바뀝니다.)

Answer 6

나는 그것을 코드 댓글이라고 부릅니다.