Convenções de estilo para elementos de código e texto

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

Convenção Explicação

variable

As variáveis aparecem em italics. 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 uma opção Booliana OU.

literal

Inclua texto ou código exatamente como mostrado.

< >

Às vezes, variáveis e outros elementos de código são exibidos entre < > colchetes. Eles são usados para melhorar a clareza em blocos de código longos. A menos que especificado, não inclua esses símbolos em um nome de arquivo de dados ou seu conteúdo.

Nesta página