Difference between revisions of "Tech Tips"
From kemiko
| Line 23: | Line 23: | ||
'''Development''': | '''Development''': | ||
<ul> | <ul> | ||
| − | Naming | + | <li> |
| − | + | Naming | |
| − | + | <ul> | |
| − | + | <li> | |
| − | + | Avoid spaces. | |
| − | + | </li> | |
| − | + | <li> | |
| − | + | Use camelCase. | |
| − | + | </li> | |
| − | + | <li> | |
| − | + | Name common items with the common word starting each item. | |
| − | + | </li> | |
| − | + | <li> | |
| − | + | 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> | |
| − | + | <li> | |
| − | </ | + | Name using noun first then verb. ex: logCreate, logList, etc. |
| − | </ | + | </li> |
| + | </ul> | ||
| + | </li> | ||
</ul> | </ul> | ||
<ul> | <ul> | ||
| − | + | <li> | |
| − | <li> | + | Coding |
| − | + | <ul> | |
| − | + | <li> | |
| − | + | Top-down and bottom-up design | |
| − | + | </li> | |
| − | + | <li> | |
| − | + | Always add comments | |
| − | + | </li> | |
| − | + | <li> | |
| − | + | Line block brackets up vertically | |
| − | + | </li> | |
| − | + | <li> | |
| − | + | Happy balance between elegance/complexity and readability/maintainability | |
| − | + | </li> | |
| − | + | <li> | |
| − | + | Happy balance between too long and too short variable naming | |
| − | + | </li> | |
| − | + | <li> | |
| − | + | Pick a style and stay consistent | |
| − | + | </li> | |
| − | + | <li> | |
| − | + | Learn your debugging tool(s)...they can save a ton of time | |
| − | + | </li> | |
| − | + | </ul> | |
| − | </li> | + | </li> |
</ul> | </ul> | ||
Revision as of 08:32, 21 November 2016
Trouble Shooting:
- Start with the basics...like power, network, etc.
General:
- Always query before running modification command(s)
- Backup or already have a backup before modifying files
- Learn your editor(s) well...it's functions can save a ton of time
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.
-
Coding
- Top-down and bottom-up design
- Always add comments
- Line block brackets up vertically
- Happy balance between elegance/complexity and readability/maintainability
- Happy balance between too long and too short variable naming
- Pick a style and stay consistent
- Learn your debugging tool(s)...they can save a ton of time