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

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

가끔 다음과 같은 사용 정보가 표시됩니다.

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%는 괜찮습니다.

요점은 "대형 기업"뿐만 아니라 유용하다고 입증된 개인이 작성한 소프트웨어도 있다는 것입니다. 그들 모두는 (희망적으로) 개별적인 방식으로 맨페이지를 작성합니다... 그들 중 대부분은 일반적인 관례를 처리할 만큼 충분히 오래 알고 있지만, 스타일 취향 등에 대해 신경 쓰지 않거나 정신적 결함이 있는 사람들도 있습니다. )

관련 정보