Show TOC Start of Content Area

Component documentation Naming Conventions  Locate the document in its SAP Library structure

Purpose

The consistent use of the following naming conventions makes the coding generated by the SAP NetWeaver Developer Studio easier to understand. The naming conventions provide you with information about the function of each generated coding entity. This facilitates understanding of the structure of a large project.

General Rules for Naming

Since all the Web Dynpro coding described here is implemented in Java, the standard naming conventions that apply for Java, also apply for Web Dynpro, but with certain restrictions.

Since Java is a Unicode-compliant language, it is possible to create variables that use characters such as ä, é, or ñ. Within Web Dynpro, such characters should not be used, especially for the names of context nodes and attributes.

SAP imposed this restriction because context names need to be kept as simple as possible.  The easiest way to do this is to restrict the characters for context names to those found in the Western Roman alphabet.

Note

Web Dynpro context names should use only the characters A..Z, a..z, 0..9 or _, where digits are allowed only from the 2nd position onwards.

Web Dynpro coding entities usually consist of one or more nouns in mixed case, with the first letter of each word capitalized.  Only whole words should be used and acronyms and abbreviations avoided unless the acronym is more widely used than the expanded form (such as URL or HTML).

Each coding entity name should start with an uppercase letter, and simple and concise terminology should be used.

A very important naming rule should always be kept in mind

Never use the prefixes wd, WD or IWD

The various forms of the “wd” prefix are used by the SAP NetWeaver Developer Studio during the generation of internal coding entities.  It is very likely that a naming conflict will occur if user-defined names.

  

  

End of Content Area