Naiade

From Elvanör's Technical Wiki
Jump to: navigation, search

This is the home page for the Naiade project.

Subversion repository is at svn://svn.elvanor.net/elvanor.net/naiade/

Currently development is halted as I am waiting for a stable MySQL ODBC driver for Linux 64 bits.

Building Naiade

Logging/Debugging under Naiade

Development Issues

Coding Conventions

Some Names/Verbs of methods:

  • get: method will return a simple internal data of the object/structure;
  • obtain: same as get, but something simple not internal is returned (a code...);
  • build: method will manipulate and build complex internal data structures, but will not return something;
  • produce: something external is obtained from the internal data structure and function arguments;
  • create: same as produce, except the object itself is returned (not an external deliverable);
  • fetch: obtain something from an external entity (usually in a static method, since it should not be a method of an object);

Do not use: generate or anything not in this list.

  • a method name always begin by a verb and first letter is not capitalized;
  • a variable name contains underscores if needed;

Example of an improvement (to the code "beauty" and maintainability):

       // ======== [IMPROVEMENT] ============
       // Here we should get the end of the correct statement. That would be better than adding a child
       // to the VariableNameNode.
       // ======== [IMPROVEMENT] ============

Example of a speed optimization:

       // +++++++++++ [OPTIMIZATION] ++++++++
       // Here we should get the end of the correct statement. That would be better than adding a child
       // to the VariableNameNode.
       // +++++++++++ [OPTIMIZATION] ++++++++

Future feature:

       // %%%%%%%%%%% [FEATURE] %%%%%%%%%%%%%
       // Here we should get the end of the correct statement. That would be better than adding a child
       // to the VariableNameNode.
       // %%%%%%%%%%% [FEATURE] %%%%%%%%%%%%%

Warning (dangerous or untested code):

       // !!!!!!!!!!! [WARNING] !!!!!!!!!!!!!
       // Here we should get the end of the correct statement. That would be better than adding a child
       // to the VariableNameNode.
       // !!!!!!!!!!! [WARNING] !!!!!!!!!!!!!

Deprecated (should be removed):

       // ---------- [DEPRECATED] -----------
       // Here we should get the end of the correct statement. That would be better than adding a child
       // to the VariableNameNode.
       // ---------- [DEPRECATED] -----------