Skip to content

Naming conventions

Davin Shearer edited this page Aug 16, 2023 · 2 revisions

Ωedit™ Naming Conventions

In a project where there are multiple words and even different character sets, you may wonder how to express the name of the project. This guide will advise you on what name to choose under what circumstances.

In publications and text

The preferred representation is Ωedit™, followed by OmegaEdit™

In logs

OmegaEdit

In source code

Snake case:

omega_edit

Camel case:

omegaEdit

Pascal case:

OmegaEdit

Skewer case:

omega-edit

Macros:

OMEGA_EDIT

Environment variables

OMEGA_EDIT

On the file system

The preference is to use all lower-case with an underscore between omega and edit. For bindings into other languages (such as Java where files are named after the classes they define), the preferred idioms of the language supersede the naming conventions in this guide.

Library names:

libomega_edit.a

libomega_edit.so

libomega_edit.dylib

libomega_edit.dll

In directory names:

omega_edit

In file names:

omega_edit.ext

Clone this wiki locally