Skip to content

Naming Conventions

Jump to bottom Edit New page
areku edited this page Dec 4, 2014 · 10 revisions
  1. Element and Operator names in CamelCase with first letter in upper case. Consecutives letters in abbreviations in lower case.

Examples: MesherTetgen, ApplyDvf

  1. Argument names (Input, Output, Parameters) in CamelCase with first letter in lower case.

Examples: meshFilename, input, inputMesh, inputHtml

  1. Every operator and element need an documentation. Please use <description> for Elements and <meta><entry key="doc"> ... </entry></meta> for Operators.
  • Operators should have a meta entry "category" for defining kind operators.

Examples: Mesher, Slicer, Vizualization, …

  1. Parameters with the output filename should be marked accordingly. (target attribute) and the name should start with t.

  2. Add a hint to the operator framework in the operator name is possible for a clear association.

    Examples: TetgenMesher, CgalMesher, …

Add a custom footer
Add a custom sidebar
Clone this wiki locally