매뉴얼 페이지에서 가변 길이 옵션을 문서화하는 올바른 방법

매뉴얼 페이지에서 가변 길이 옵션을 문서화하는 올바른 방법

가끔 다음과 같은 사용 메시지가 표시됩니다.

some_utility [arg [arg [...]]]

또는

some_utility [arg[, arg[...]]]

이는 여러 개의 동일한 매개변수를 전달할 수 있음을 보여줍니다.

나도 비슷한거 본적 있음

some_utility [args]

또는

some_utility [arg][, arg][...]

이를 수행하는 표준 방법이 있습니까?

답변1

아니요, 그렇지 않습니다.진짜, 그러나 대부분의 경우 꽤 일관성이 있습니다. 대부분의 매뉴얼에는 선택적 매개변수가 대괄호( )로 표시되어 있고 [foo], 필수 매개변수가 꺾쇠괄호로 표시되어 있거나 괄호가 전혀 표시되어 있지 않습니다( <bar>, baz, 후자는 일반적으로 밑줄이 그어져 있음).

또한 거의 모든 경우에 인수의 수가 가변적이라면 일종의 목록(당신이 언급한 것처럼 [quux ...]또는 [quux[, quux[...]]]...)이 있을 것입니다. 여기서 유사하게 [quuz]대부분의 경우 정확하게 표현됩니다.하나토론. 드문 경우지만 [quuz]"하나 이상의 인수"를 의미할 수도 있지만 대부분의 매뉴얼은 목록 형식에서 줄임표를 따릅니다.

이는 준표준이지만 절대적으로 신뢰할 수는 없습니다. 하지만 제 경험에 따르면 95%는 문제가 되지 않습니다.

요점은 "대형 기업"뿐만 아니라 개인이 작성한 유용하다고 입증된 소프트웨어까지 다양한 색상의 소프트웨어 공급업체가 수백 개 있다는 것입니다. 그들 모두는 (희망적으로) 개인적인 방식으로 맨페이지를 작성합니다... 그들 중 대부분은 일반적인 관례를 처리할 수 있을 만큼 오랫동안 그것을 알고 있었지만 스타일 취향 등에 관심이 없거나 문제가 있는 사람들도 있습니다. 결함;)

관련 정보