Historical CodingConvention, Revision 6

These are coding conventions and requirements for code accepted into Euphoria. These are simple rules right now, but we will expand this document in the future.

The purpose of this document is solely to protect the future of Euphoria. Source code and development without rules only lead to a tangled mess that will soon be abandoned.

  1. global should never be used.
  2. Before submitting any new functions, it must contain basic tests proving it at least functions and documentation. The documentation should include a general description, detailed parameter descriptions and detailed return value (if a function). If at all possible, an example is highly recommended. Optional sections include Comments, which are any special notes the user might need to be aware of and also a See Also section.
  3. Before committing code, tests should be run (all tests, not just new functionality tests)
  4. Source files should be indented with a tab character, not spaces.
  5. Reuse the standard library, do not reinvent the wheel.
  6. Choose good, descriptive names but not too lengthy. Use good judgement finding a happy medium.

Search



Quick Links

User menu

Not signed in.

Misc Menu