Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| design:coding_standards [2010/07/23 16:29] – jeff | design:coding_standards [2020/11/19 14:21] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Tasks ====== | ||
| + | |||
| + | ===== determining schedule ===== | ||
| + | |||
| + | * Short - Less than a week ( a day or 2) | ||
| + | * Medium - 1 week | ||
| + | * Long - +2 weeks | ||
| + | * Suxly - Unknown. | ||
| + | |||
| + | ===== Logging effort ===== | ||
| + | |||
| + | * use the comment you put in svn to comment the work you did for a given task. | ||
| + | * 95% complete means that you are done and the task needs to be reviewed | ||
| + | * 90% complete means that the task has some rework that needs done | ||
| + | * 100% complete means that the task is done but this can only be set by the manager. | ||
| + | |||
| ====== Coding Standards ====== | ====== Coding Standards ====== | ||
| [[http:// | [[http:// | ||
| + | |||
| + | [[http:// | ||
| + | |||
| + | [[http:// | ||
| ===== Version Control ===== | ===== Version Control ===== | ||
| Line 10: | Line 30: | ||
| ==== SVN ==== | ==== SVN ==== | ||
| Help on how svn works behind a proxy: | Help on how svn works behind a proxy: | ||
| + | |||
| + | Eclipse: http:// | ||
| You will need svn for command line which is availible through collabnet. | You will need svn for command line which is availible through collabnet. | ||
| Line 19: | Line 41: | ||
| Files that are not allowed: | Files that are not allowed: | ||
| < | < | ||
| - | *.o *.lo *.la *.al .libs *.so *.so.[0-9]* *.a *.pyc *.pyo *.rej *~ #*# .#* .*.swp .DS_Store *.ncb *.sln *.suo Debug Release *.user bin obj | + | *.o *.lo *.la *.al .libs *.so *.so.[0-9]* *.a *.pyc *.pyo *.rej *~ #*# .#* .*.swp .DS_Store *.ncb *.suo Debug* Release* *.user bin obj build out |
| </ | </ | ||
| + | |||
| + | ==== GitLab ==== | ||
| + | |||
| + | May want to switch to GitLab. | ||
| + | * [[https:// | ||
| ===== Versioning ===== | ===== Versioning ===== | ||
| Line 49: | Line 76: | ||
| For PHP use | For PHP use | ||
| - | For ActionScript | + | For ActionScript |
| For HTML use | For HTML use | ||
| Line 113: | Line 140: | ||
| ===== Code Format ===== | ===== Code Format ===== | ||
| - | Spacing will be 4 spaces for tabs. If your editor supports it, which most do, change your tabs to spaces and make sure it is 4. For a single file of code always put variables first, then helper functions then execution functions. | + | Spacing will be 4 spaces for tabs. If your editor supports it, which most do, change your tabs to spaces and make sure it is 4. For a single file of code always put variables first, then helper functions then execution functions. |
| Sample | Sample | ||
| Line 122: | Line 149: | ||
| static int VAR_WITH_SPACES; | static int VAR_WITH_SPACES; | ||
| - | // Variable declerations | + | // Public Variable declerations |
| + | int m_VarNoSpaces; | ||
| + | |||
| + | // Protected Variable declerations | ||
| + | int m_VarNoSpaces; | ||
| + | |||
| + | // Private | ||
| int m_VarNoSpaces; | int m_VarNoSpaces; | ||
| Line 157: | Line 190: | ||
| jtf_NameOfUser // Gui var in this case it's "java text field" | jtf_NameOfUser // Gui var in this case it's "java text field" | ||
| + | ===== Tools ===== | ||
| + | |||
| + | * [[https:// | ||
| + | * [[https:// | ||
| + | * mosquito - MQTT | ||
| + | * [[https:// | ||
| + | * [[|User Accessibility]] | ||
| + | * [[https:// | ||
| + | * [[https:// | ||
| + | * [[https:// | ||
| + | * [[http:// | ||
| + | * ESLint | ||
| + | * Puma | ||
| + | * [[http:// | ||
| + | * [[http:// | ||
| + | * [[http:// | ||
| + | * [[http:// | ||
| + | * Visual Studio - [[https:// | ||
