Parameter

OpenOffice.org Developer's Guide

OpenOffice.org API-Design-Guidelines

< Previous Section

Next Section >

• General Design Rules
• Definition of API Elements

• Attributes
• Methods
• Interfaces
• Properties
• Events
• Services
• Exceptions
• Enums
• Typedefs
• Structs
• Parameter

• Special Cases
• Abbreviations
• Source Files and Types

< Previous Page

Next Page >

Parameters are names for arguments of methods.

Naming

Argument identifiers begin with a special lowercase letter as a prefix and put in initial caps later, for example, nItemCount.

Use the following prefixes:

• 'x' for interfaces
• 'b' for boolean values
• 'n' for integer numbers
• 'f' for floating point numbers
• 'a' for all other types. These are represented as classes in programming languages.

Usage

The order of parameters is defined by the following rule: Where, What, How. Within these groups, order by importance. For example, insertContent(USHORT nPos, XContent xContent,and boolean bAllowMultiInsert.

Content on this page is licensed under the Public Documentation License (PDL).