Esses elementos identificam as opções de código e as variáveis usadas na documentação de ajuda. Geralmente, você não incluiria esses símbolos ou elementos de estilo em seu código ou arquivos de dados. São apenas indicadores visuais.
Convenção | Explicação |
---|---|
|
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. |
|
Os itens entre colchetes são opcionais. |
|
Os itens entre parênteses indicam uma opção booleana OU. |
|
Inclua texto ou código exatamente como mostrado. |
|
Às vezes, as 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 seja especificado, não inclua esses símbolos em um nome de arquivo de dados ou em seu conteúdo. |