iSharkFly-Docs/angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-docs-cn/NAMING.md
Igor Minar da41a954b5 docs: branding fixes (#14132) 
Angular 1.x -> AngularJS
Angular 1 -> AngularJS
Angular1 -> AngularJS
Angular 2+ -> Angular
Angular 2.0 -> Angular
Angular2 -> Angular

I have deliberately not touched any of the symbol names as that would cause big merge collisions with Tobias's work.

All the renames are in .md, .json, and inline comments and jsdocs.

PR Close #14132
2017-01-27 15:03:11 -06:00

883 B
Raw Blame History

Naming Conventions in Angular

In general Angular should follow TypeScript naming conventions. See: https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines

Classes:

  • Example: Compiler, ApplicationMetadata
  • Camel case with first letter upper-case
  • In general prefer single words. (This is so that when appending Proto or Factory the class is still reasonable to work with.)
  • Should not end with Impl or any other word which describes a specific implementation of an interface.

Interfaces:

  • Follow the same rules as Classes
  • Should not have I or Interface in the name or any other way of identifying it as an interface.

Methods and functions:

  • Example: bootstrap, someMethod
  • Should be camel case with first lower case

Constants

  • Example: CORE_DIRECTIVES
  • Should be all uppercase with SNAKE_CASE