

  
                             3D Foundation Classes



                           *** CODING CONVENSIONS ***



     -------------------
      Table of Contents
     -------------------



           Variables and Functions Notation

           Code Convensions



     ----------------------------------
      Variables and Functions Notation
     ----------------------------------



           I use my self variation for the hungarian variable

           naming convencion to write the code. This convencion

           define short prefixes onto each variable, function

           and type name to denote it's properties. The prefixes

           are in lower case, the next letter alway is upper case.



             PREFIX     DATA TYPE OR USE CASE

               b        boolean
                        Ex.: BOOL bTest;

               ch       character (char)

               d        double

               dw       unsigned long int (double word, 32 bits)

               f        floating point
                        Ex.: float fPi = 3.1415;

               n        integer (32 or 16 bits)

               u        unsigned integer (32 or 16 bits)

               sz       NULL-terminated string

               w        word (16 bits)

               y        byte

               v        void

               a        array
                        Ex.: char achMyWidth [ 6 ];    (Array with 6 CHar's)

               p        pointer (compound type: pf, pu), used to
                        refer array allocated dymanicaly
                        Ex.: int *panMyArray;    (Pointer to an Array of iNt)

               tag      name of a structure declaration
                        Ex.: struct tagMyData { int nX, nY; };

               st       struct instance
                        Ex.: tagA stMyData;

               o        object instance

               C        class
                        Ex.: class CName { ... };

               enum     name of an enumeration declaration
                        Ex.: enum enumDays { DAY1, DAY2, DAY3 };

               c        counter variable
                        Ex.: for ( int ncX=0; ncX < 100; ncX ++ );

               m_       member variable of a class
                        Ex.: class CName { int m_nAlpha; };

               m        member function of a class
                        Ex.: class CName { void mCreate (); };



     ------------------
      Code Convensions
     ------------------


            
            // REVIEW - text under construction
            
            Remarks
               1-
               2-
               default
               return




               Set      function that set values from a class
                        member variables

               Ret      function that get (return) values
                        from a class member variables

            mSetObj
            mCreate
            mDestroy
            operator =

            Reference Systems Notation
               SRU
               SRO
               SRH (depende do pai)
               SRC
