문서 블록
Docblock |
프로그래밍에서 DocBlock 또는 DocBlock은 소스 코드에 지정된 특수 형식의 주석으로, 코드의 특정 세그먼트를 문서화하는 데 사용됩니다.이렇게 하면 DocBlock 형식은 주석을 지원하는 경우 대상 언어와 독립적이지만 여러 표준 또는 일관되지 않은 표준으로 이어질 수 있습니다.
구현 예
C#
<summary> 두 정수를 함께 추가합니다.</cisco> <param name="a">첫 번째 정수.</param> <param name="b"> 두 번째 정수.</param> <<고객명>정수 a와 b의 합.</cisco> 인트 합(인트 a, 인트 b) { 돌아가다 a + b; } 자바
/** 두 정수를 함께 추가합니다. * @parama 첫 번째 정수 @paramb 두 번째 정수 @return 정수 a와 b의 합 */ 인트 합(인트 a, 인트 b) { 돌아가다 a + b; } PHP
<?>의 /** 두 정수를 함께 추가합니다. * @paramint $a 첫 번째 정수 @paramint $b 두 번째 정수 @return int 정수 $a와 $b의 합계 */ 기능. 합(인트 a달러, 인트 $b): 인트 { 돌아가다 a달러 + $b; } 파이썬
디프 합(a: 인트, b: 인트) -> 인트 "" 두 정수를 함께 추가합니다. 인수: a: 첫 번째 정수. b: 두 번째 정수. 반환: 두 정수의 합입니다. """ 돌아가다 a + b 자바스크립트
/** 두 개의 숫자를 함께 추가합니다. @param {number} a 첫 번째 숫자. @param {number} b 두 번째 숫자. @{number}개의 숫자 a와 b의 합계를 반환합니다. */ 컨스 더하다 = (a, b) => a + b; 루비
## 이 클래스는 일련의 점으로 임의의 모양을 나타냅니다. 학급 모양. ## +polyline+로 설명되는 새 도형을 작성합니다. # +polyline+가 동일한 지점에서 끝나지 않으면 다음 지점에서 시작됩니다. 첫 번째 점이 복사되어 줄의 끝에 배치됩니다. # 선이 자신과 교차하는 경우 ArgumentError가 발생하지만 도형은 그럴 수 있습니다. 움푹 패다 디프 초기화 폴리라인 # ... 끝. 끝. 러스트
두 개의 숫자를 함께 추가합니다. ///// # 예제 /// "/" // 결과 = sum(5, 5); // "/" fn sum(a: u64, b: u64) -> u64 { a + b }
