Convenções de estilo para elementos de código e texto style-conventions-for-code-and-text-elements

Esses elementos identificam as opções de código e variáveis usadas na documentação de ajuda. Geralmente, esses símbolos ou elementos de estilo não são incluídos nos arquivos de código ou de dados. Eles são apenas indicadores visuais.

Convenção
Explicação
variable

As variáveis aparecem em itálico. Substitua o valor apropriado para o nome da variável.

Para maior clareza visual, às vezes as variáveis e outros elementos de código aparecem entre < > colchetes. Não é necessário usar esses símbolos no código.

[optional]
Os itens entre colchetes são opcionais.
(this|that)
Os itens entre parênteses indicam um valor booleano OU escolha.
literal
Incluir texto ou código exatamente como mostrado.
< >
Às vezes, as variáveis e outros elementos de código aparecem entre < > colchetes. Eles são usados para melhorar a clareza em blocos de código longos. A menos que seja especificado, não inclua esses símbolos em um nome de arquivo de dados ou seu conteúdo.
recommendation-more-help
de293fbf-b489-49b0-8daa-51ed303af695