Changes between Version 11 and Version 12 of HowtoGoodProgrammingTechniques


Ignore:
Timestamp:
Nov 16, 2012, 6:35:13 AM (12 years ago)
Author:
Thanatermesis
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • HowtoGoodProgrammingTechniques

    v11 v12  
    4646== Convention Names ==
    4747
    48 Names in variables and functions are something very important, the convention to use is to be the smallest-size possible with a perfect understanding of its name and what exactly does, think on the structure like in object-programming languages, where the first name needs to be the biggest element and the last the smaller one, and in the end include the action.
     48Names in variables and functions are something very important, the convention to use is to be the smallest-size possible with a perfect understanding of its name and what exactly does, think on the structure like in object-programming languages, where the first name needs to be the biggest element and the last the smaller one, and in the end include the action, it should look like an hierachy in object-oriented elements.
     49
     50It is a good procedure to rename all the functions after the app is finished, by reading the list of all of them and decide the optimal names structure for the entire code, same for global variables.
    4951
    5052=== Never do names like that ===
     
    67691. Minimize the code (less lines, simple and short functions, less-complex algorithms, etc)
    68701. Structure it correctly (spaces/readability, comments, begin-end parts, local variables, etc)
    69 1. Document (comment) the needed parts to make it easly understandable, suggestion: use doxygen syntax
    70 1. Convention names, take some seconds to decide the optimal names for your variables and calls
     711. Document (comment) the needed parts to make it easly understandable, is suggested to use doxygen syntax
     721. Convention names, take some seconds to decide the optimal names for your variables and functions
    7173
    7274== Extra ==