Recent changes to Code_Style_Conventions

WikiPage Code_Style_Conventions modified by Shane Saxon

Shane Saxon — Sat, 31 Mar 2012 19:43:09 -0000

--- v6 
+++ v7 
@@ -1,29 +1,31 @@
-[Home]
-also see [Cross_Platform_Guide]
-
+[Home] - [Cross_Platform_Guide] - hosted at [openANTz.com](http://openantz.com/)
+
+ANTz is currently a stand-alone app. However, we plan to make it into an API library that can be bolted into other programs such as data visualization, CAD, 3D modeling, network management, gaming and entertainment (film & video.)
+
+We are significantly dependent on the OpenGL library and borrow some conventions from SGI as well as conventions used in DB processing.
+
 In general we try and keep the code in a consistent style to help with readability and maintainability.
 
 Code Conventions:
-- Keep width to 80 characters.
-- Keep variable names short, describe variable details where they are declared.
-- Init variables to zero or Null when declared.
-- All code files should have the prefix 'np...h/c'.
-- Functions have prefix 'np...' (those in .h files) ie: 'npMyFunction'
+- Keep width to 80 characters, (exceptions okay when necessary or practical.)
+- Declare local headers at top of the '.c' file.
+- Declare local function prototypes at top of '.c' file.
+- Declare all variables before any code logic and init to 0 or NULL.
+- Keep names short and descriptive, describe details using comments where declared.
+- All code files should be lower case and have the prefix 'np'.
+- Functions in header files should also have prefix 'np' ie: 'npMyFunction()'.
 - Variables start with lower case and use upper case for new words 'myVariable'.
 - Constants prefix is 'kNP..' then start with lower-case, ie: 'kNPgraphPause'.
 - Check malloc errors for out of memory.
-- Declare local function prototypes at top of file.
-
-File & DB Conventions:
+
+Data File & DB Conventions:
 - All data files should have the prefix 'ANTz...csv/xml/etc'
 - CSV files should be directly compatible with DB tables.
 - Field names in the first row.
 - Data records each row after that. See wikipedia for CSV standards...
 - Field names should be of form 'rotate_rate_x' (in C this is 'rotateRate.x')
 
-We are significantly dependent on the OpenGL library and borrow some conventions from SGI as well as conventions used in DB processing.
-
-ANTz is currently a stand-alone app, however, the plan is to make it into an API library that can be bolted into other programs such as data visualization, CAD, 3D modeling, network management, gaming and entertainment (film & video.)
+--- below are additional details under construction ---
 
 Functions:
 - External visible API functions precede with 'np' followed by an optional lower case abbreviation for the file or category. In example nposFileDialog()

WikiPage Code_Style_Conventions modified by Shane Saxon

Shane Saxon — Wed, 28 Mar 2012 19:18:42 -0000

--- v5 
+++ v6 
@@ -1,7 +1,7 @@
 [Home]
+also see [Cross_Platform_Guide]
+
 In general we try and keep the code in a consistent style to help with readability and maintainability.
-
-Also see [Cross_Platform_Guide]
 
 Code Conventions:
 - Keep width to 80 characters.

WikiPage Code_Style_Conventions modified by Shane Saxon

Shane Saxon — Wed, 28 Mar 2012 19:15:45 -0000

--- v4 
+++ v5 
@@ -4,12 +4,13 @@
 Also see [Cross_Platform_Guide]
 
 Code Conventions:
-- Keep width to 80 characters
-- Keep variable names short, describe variable details where they are declared
-- All code files should have the prefix 'np...h/c'
+- Keep width to 80 characters.
+- Keep variable names short, describe variable details where they are declared.
+- Init variables to zero or Null when declared.
+- All code files should have the prefix 'np...h/c'.
 - Functions have prefix 'np...' (those in .h files) ie: 'npMyFunction'
-- Variables start with lower case and use upper case for new words 'myVariable'
-- Constants prefix is 'kNP..' then start with lower-case, ie: 'kNPgraphPause'
+- Variables start with lower case and use upper case for new words 'myVariable'.
+- Constants prefix is 'kNP..' then start with lower-case, ie: 'kNPgraphPause'.
 - Check malloc errors for out of memory.
 - Declare local function prototypes at top of file.

WikiPage Code_Style_Conventions modified by Shane Saxon

Shane Saxon — Wed, 28 Mar 2012 19:09:19 -0000

--- v3 
+++ v4 
@@ -11,6 +11,7 @@
 - Variables start with lower case and use upper case for new words 'myVariable'
 - Constants prefix is 'kNP..' then start with lower-case, ie: 'kNPgraphPause'
 - Check malloc errors for out of memory.
+- Declare local function prototypes at top of file.
 
 File & DB Conventions:
 - All data files should have the prefix 'ANTz...csv/xml/etc'

WikiPage Code_Style_Conventions modified by Shane Saxon

Shane Saxon — Wed, 28 Mar 2012 05:47:03 -0000

--- v2 
+++ v3 
@@ -1,30 +1,35 @@
+[Home]
 In general we try and keep the code in a consistent style to help with readability and maintainability.
 
+Also see [Cross_Platform_Guide]
+
 Code Conventions:
 - Keep width to 80 characters
 - Keep variable names short, describe variable details where they are declared
 - All code files should have the prefix 'np...h/c'
 - Functions have prefix 'np...' (those in .h files) ie: 'npMyFunction'
 - Variables start with lower case and use upper case for new words 'myVariable'
 - Constants prefix is 'kNP..' then start with lower-case, ie: 'kNPgraphPause'
+- Check malloc errors for out of memory.
 
 File & DB Conventions:
 - All data files should have the prefix 'ANTz...csv/xml/etc'
 - CSV files should be directly compatible with DB tables.
 - Field names in the first row.
 - Data records each row after that. See wikipedia for CSV standards...
 - Field names should be of form 'rotate_rate_x' (in C this is 'rotateRate.x')
 
 We are significantly dependent on the OpenGL library and borrow some conventions from SGI as well as conventions used in DB processing.
 
 ANTz is currently a stand-alone app, however, the plan is to make it into an API library that can be bolted into other programs such as data visualization, CAD, 3D modeling, network management, gaming and entertainment (film & video.)
 
 Functions:
 - External visible API functions precede with 'np' followed by an optional lower case abbreviation for the file or category. In example nposFileDialog()
 
 Variables:
 
 Constants:
 - We often use defined constants in place of variables.
 - Most constants should be placed the nptypes.h file.
 - Use the prefix 'kNP' followed by a lower-case name
+

WikiPage Code_Style_Conventions modified by Shane Saxon

Shane Saxon — Sun, 25 Mar 2012 22:33:55 -0000

WikiPage Code Style & Name Conventions modified by Shane Saxon

Shane Saxon — Sun, 25 Mar 2012 20:43:12 -0000

In general we try and keep the code in a consistent style to help with readability and maintainability. Code Conventions: - Keep width to 80 characters - Keep variable names short, describe variable details where they are declared - All code files should have the prefix 'np...h/c' - Functions have prefix 'np...' (those in .h files) ie: 'npMyFunction' - Variables start with lower case and use upper case for new words 'myVariable' - Constants prefix is 'kNP..' then start with lower-case, ie: 'kNPgraphPause' File & DB Conventions: - All data files should have the prefix 'ANTz...csv/xml/etc' - CSV files should be directly compatible with DB tables. - Field names in the first row. - Data records each row after that. See wikipedia for CSV standards... - Field names should be of form 'rotate_rate_x' (in C this is 'rotateRate.x') We are significantly dependent on the OpenGL library and borrow some conventions from SGI as well as conventions used in DB processing. ANTz is currently a stand-alone app, however, the plan is to make it into an API library that can be bolted into other programs such as data visualization, CAD, 3D modeling, network management, gaming and entertainment (film & video.) Functions: - External visible API functions precede with 'np' followed by an optional lower case abbreviation for the file or category. In example nposFileDialog() Variables: Constants: - We often use defined constants in place of variables. - Most constants should be placed the nptypes.h file. - Use the prefix 'kNP' followed by a lower-case name