Convenções de documentos para documentos do Office para desenvolvedores
Nossos documentos usam convenções de documentos específicos para ajudá-lo a distinguir código-fonte de elementos de linguagem, seqüências de teclado e assim por diante. A tabela a seguir esclarece as convenções que são usadas na documentação do desenvolvedor do Office e chamadas de exceções por produto.
**Última alteração:**quinta-feira, 17 de setembro de 2015
**Aplica-se a:**Office 2010 | Office 2013
Convenções tipográficas que se aplicam a todos os produtos do Office para desenvolvedores e tecnologias
Convenção |
Descrição |
Exemplo |
---|---|---|
Espaçamento uniforme |
Indica o código-fonte, exemplos de código, a linha de comando, a saída do aplicativo, linhas de código de entrada incorporados em variáveis e texto e os elementos de código. |
Public Class |
Negrito |
Indica a mais predefinidos elementos de programação, incluindo namespaces, classes, representantes, objetos, interfaces, métodos, funções, macros, estruturas, construtores, propriedades, eventos, enumerações, campos, operadores, instruções, diretivas, tipos de dados, palavras-chave, exceções, atributos não-HTML e marcas de configuração, bem como as chaves do registro, subchaves e valores. Também indica os seguintes elementos HTML: atributos (minúsculo), diretivas, palavras-chave, valores e cabeçalhos. Além disso, indica a entrada do usuário necessária (incluindo as opções de linha de comando) que deve ser inserida exatamente como mostrado. Por fim, indica nomes de elemento XML e nomes de atributo XML (que são digitados conforme escrito na XSD). |
Caminho de classe Método resolve atributo href elemento de trechos de código atributo de palavra-chave |
Itálico |
Indica espaços reservados, com mais frequência método ou parâmetros de função e espaços reservados HTML; Esses espaços reservados representam informações que devem ser fornecidas pela implementação ou pelo usuário. Para a entrada de linha de comando, indica os valores de parâmetro. |
parâmetro de contexto |
Letras maiúsculas |
Indica os nomes das chaves e sequências de teclas. Também indica os nomes de elementos HTML. |
ENTER CTRL + R Elemento HTML |
Plus sign |
Indica uma combinação de teclas. Por exemplo, ALT + F1 significa manter pressionada a tecla ALT enquanto pressiona a tecla F1. |
ALT + F1 |
Exceções à convenções de documentos por produto
Produto |
Convenção |
Descrição |
Exemplo |
---|---|---|---|
Visio |
Capitalização do texto sem formatação, camel |
Indica a células e linhas. |
Célula AlignMiddle Linha ArcTo |
Visio |
Texto sem formatação, letras maiúsculas |
Indica as funções |
Função ANGLETOLOC |
Visio |
Texto sem formatação, caps título |
Indica as seções |
Seção Shape Layout |