Dokumentkonventionen für Office Developer-Dokumente
Unsere Dokumente verwenden bestimmte Dokumentkonventionen beim Quellcode von Sprachelemente, Tastenfolgen und So weiter zu unterscheiden. In der folgenden Tabelle verdeutlicht die Konventionen, die über Office-Entwicklerdokumentation verwendet werden, und Ausnahmen nach Produkt aufruft.
**Letzte Änderung:**Donnerstag, 17. September 2015
**Gilt für:**Office 2010 | Office 2013
Typografischen Konventionen, die in allen Office Developer-Produkte und -Technologien anwenden
Konvention |
Beschreibung |
Beispiel |
|---|---|---|
Festbreitenschrift |
Gibt an, Quellcode, Codebeispiele, Eingaben an der Befehlszeile, Anwendungsausgabe, Codezeilen in Text, sowie Variablen und Codeelemente eingebettet. |
Public Class |
Bold |
Gibt die meisten vordefinierte programming Elemente, einschließlich Namespaces, Klassen, Delegaten, Objekte, Schnittstellen, Methoden, Funktionen, Makros, Strukturen, Konstruktoren, Eigenschaften, Ereignisse, Enumerationen, Felder, Operatoren, Anweisungen, Direktiven, Datentypen, Schlüsselwörter, Ausnahmen, nicht-HTML-Attribute aufgeführt, und Konfigurationstags, als auch Registrierungsschlüssel, Unterschlüssel und Werte an. Gibt auch die folgenden HTML-Elemente: Attribute (Kleinbuchstabe), Direktiven, Schlüsselwörter, Werte und Kopfzeilen. Darüber hinaus gibt (einschließlich Command-Line Options) Erforderlicher Benutzereingaben, die genau wie angezeigt eingegeben werden muss. Schließlich gibt XML-Elementnamen und XML-Attributnamen (die eingegeben werden, wie in der XSD geschrieben). |
Path -Klasse Auflösen -Methode Href -Attribut Codeausschnitt -element Schlüsselwort -Attribut |
Kursiv |
Gibt an, Platzhalter, in den meisten Fällen-Methode oder Funktionsparameter und HTML-Platzhalter. Diese Platzhalter stehen für Informationen, die durch die Implementierung oder vom Benutzer angegeben werden muss. Für Command-Line Input gibt Parameterwerte. |
Kontext -parameter |
Großbuchstaben |
Gibt die Namen von Tasten und Tastenkombinationen an. Gibt außerdem HTML-Elementnamen an. |
EINGABETASTE STRG+R HTML-Element |
Pluszeichen |
Gibt eine Kombination von Schlüsseln. Beispielsweise bedeutet, dass ALT + F1 die ALT-Taste gedrückt, während Sie die F1-Taste drücken. |
ALT + F1 |
Ausnahmen zu Dokumentkonventionen nach Produkt
Product |
Konvention |
Beschreibung |
Beispiel |
|---|---|---|---|
Visio |
Nur-Text wird Groß-/Kleinschreibung |
Gibt an, Zeilen und Zellen. |
Zelle "AlignMiddle" Zeile "ArcTo" |
Visio |
Nur-Text in Großbuchstaben an |
Gibt an, Funktionen |
ANGLETOLOC Function |
Visio |
Nur-Text, Titel caps |
Gibt die Abschnitte an |
Shape Layout Section |