Maneira correta de documentar opções de comprimento variável em páginas de manual

Maneira correta de documentar opções de comprimento variável em páginas de manual

Às vezes vejo informações de uso como

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

ou

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

isso indica que você pode passar mais de um mesmo argumento.

Eu também já vi assim

some_utility [args]

ou

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

Existe uma maneira padrão de fazer isso?

Responder1

Não, nãorealmente, mas na maioria das vezes é bastante consistente. A maioria dos manuais listaria os argumentos opcionais com colchetes ( [foo]), os obrigatórios com colchetes angulares ou sem colchetes ( <bar>, baz, este último frequentemente sublinhado).

Além disso, em quase todos os casos, se o número de argumentos for variável, você terá algum tipo de lista (como você mencionou, [quux ...]ou [quux[, quux[...]]]...), onde da mesma forma [quuz]na maioria das vezes denota exatamenteumargumento. Em casos raros, [quuz]também pode significar “um ou mais argumentos”, mas a maioria dos manuais obedece às reticências do formulário de listagem.

É quase um padrão, mas você definitivamente não pode confiar nele. Mas, na minha experiência, está tudo bem em 95% das vezes.

A questão é que existem centenas de fornecedores de software de qualquer cor por aí, não apenas “grandes jogadores”, mas também software escrito por indivíduos individuais que se mostrou útil. Todos eles (espero) escrevem suas páginas de manual de alguma maneira individual... a maioria deles sabe o suficiente para cuidar das convenções comuns, mas também há aqueles que não se importam ou têm algum tipo de defeito mental em relação ao gosto de estilo etc.; )

informação relacionada