Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • D digitec-wiki
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Deployments
    • Deployments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Digitec
  • digitec-wiki
  • Wiki
  • javascript coding standards

javascript coding standards · Changes

Page history
rcabral created page: javascript-coding-standards authored Dec 11, 2013 by Rene Cabral's avatar Rene Cabral
Hide whitespace changes
Inline Side-by-side
javascript-coding-standards.markdown
View page @ 3da39546
...@@ -110,9 +110,7 @@ class FooBar ...@@ -110,9 +110,7 @@ class FooBar
* Exception message strings should be concatenated using sprintf. * Exception message strings should be concatenated using sprintf.
### Naming Conventions
* Use camelCase, not underscores, for variable, function and method names, arguments; * Use camelCase, not underscores, for variable, function and method names, arguments;
* Use underscores for option names and parameter names; * Use underscores for option names and parameter names;
...@@ -124,16 +122,21 @@ class FooBar ...@@ -124,16 +122,21 @@ class FooBar
* Suffix interfaces with Interface; * Suffix interfaces with Interface;
* Suffix traits with Trait; * Suffix traits with Trait;
* Suffix exceptions with Exception; * Suffix exceptions with Exception;
* Use alphanumeric characters and underscores for file names; * Use alphanumeric characters and underscores for file names;
* Don't forget to look at the more verbose Conventions document for more subjective naming considerations.
* Don't forget to look at the more verbose Conventions document for more subjective naming considerations.
### Documentation
* Add PHPDoc blocks for all classes, methods, and functions;
* Omit the @return tag if the method does not return anything; * Omit the @return tag if the method does not return anything;
* The @package and @subpackage annotations are not used. * The @package and @subpackage annotations are not used.
...@@ -141,6 +144,7 @@ class FooBar ...@@ -141,6 +144,7 @@ class FooBar
#### References #### References
PDF versions of some of these documents are attached, in case the web page does not exist anymore, prefer the actual web page if available. PDF versions of some of these documents are attached, in case the web page does not exist anymore, prefer the actual web page if available.
......
Clone repository
  • alpha beta testing
  • browser testing
  • camtasia licenses
  • code delivery processes
  • coding practices
  • css and sass coding standards
  • database schema standards
  • dependency management
  • development environments
  • digitec agile process
  • digitec gitlab styles
  • digitec software promises
  • digitec spec process
  • gitlab administration
  • gitlab issues tags
View All Pages