Actions

Difference between revisions of "Tech Tips"

From kemiko

Line 3: Line 3:
  
 
'''Development''':
 
'''Development''':
* Naming of file and variables
+
<ul>
 
+
Naming
* Avoid spaces
+
<ul>
 
+
  <li>
   * This is more a conventional necessity, but still a good one
+
  Avoid spaces.
 
+
  </li>
* Camelcase
+
   <li>
 
+
  Use camelCase.
   * Run words together capitalizing the first letter of each word connected to the first...logCreate, logList, etc.
+
  </li>
* Start by naming common item with the word first.
+
   <li>
   * web servers webXX, database servers dbXX, etc.
+
  Name common items with the common word starting each item.
* Always start naming with numbers that will always sort correctly 1-10 won't sort correctly when reaching 10...use 01-10, etc.
+
   </li>
* Start with noun first then verb
+
  <li>
  * sanityCheck vs checkSanity
+
  Name same item, but numbered with enough padding to sort correctly.  ex: if going to at least 10 use 01-10 instead of 1-10.
 +
  </li>
 +
  <li>
 +
  Name date by number not name and most general to specific.  So they sort correctly. ex: 20161231 instead of Dec31-2016, etc.
 +
  </li>
 +
  Name using noun first then verb.  ex: logCreate, logList, etc.
 +
</ul>
 +
</ul>

Revision as of 21:15, 19 November 2016

Trouble Shooting:

  • start with the basics...like power, network, etc.

Development:

    Naming
    • Avoid spaces.
    • Use camelCase.
    • Name common items with the common word starting each item.
    • Name same item, but numbered with enough padding to sort correctly. ex: if going to at least 10 use 01-10 instead of 1-10.
    • Name date by number not name and most general to specific. So they sort correctly. ex: 20161231 instead of Dec31-2016, etc.
    •   Name using noun first then verb.  ex: logCreate, logList, etc.