angular-docs-cn/docs/NAMING.md

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
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 01:30:42 -05:00			`Naming Conventions in Angular`
chore: add NAMING.md Closes #3787 2015-08-21 23:13:31 -04:00			`---`

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 01:30:42 -05:00			`In general Angular should follow TypeScript naming conventions.`
chore: update NAMING.md with TypeScript conventions 2015-08-26 14:48:09 -04:00			`See: https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines`
chore: add NAMING.md Closes #3787 2015-08-21 23:13:31 -04:00

			`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.)`
chore: update NAMING.md with TypeScript conventions 2015-08-26 14:48:09 -04:00			- Should not end with `Impl` or any other word which describes a specific implementation of an
chore: add NAMING.md Closes #3787 2015-08-21 23:13:31 -04:00			`interface.`


			`Interfaces:`
			`- Follow the same rules as Classes`
chore: update NAMING.md with TypeScript conventions 2015-08-26 14:48:09 -04:00			- Should not have `I` or `Interface` in the name or any other way of identifying it as an interface.
chore: add NAMING.md Closes #3787 2015-08-21 23:13:31 -04:00

			`Methods and functions:`
refactor(ngProbe): rename to ng.probe BREAKING CHANGE: Closes #3786 - ngProbe => ng.probe 2015-08-28 13:36:58 -04:00			- Example: `bootstrap`, `someMethod`
chore: add NAMING.md Closes #3787 2015-08-21 23:13:31 -04:00			`- Should be camel case with first lower case`


docs: add missing colon in the Constants section of NAMING.md 2017-03-02 01:55:14 -05:00			`Constants:`
chore: add NAMING.md Closes #3787 2015-08-21 23:13:31 -04:00			- Example: `CORE_DIRECTIVES`
			`- Should be all uppercase with SNAKE_CASE`