angular-cn/NAMING.md

33 lines
883 B
Markdown
Raw Normal View History

Naming Conventions in Angular
2015-08-21 23:13:31 -04:00
---
In general Angular should follow TypeScript naming conventions.
See: https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines
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.)
- Should not end with `Impl` or any other word which describes a specific implementation of an
2015-08-21 23:13:31 -04:00
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.
2015-08-21 23:13:31 -04:00
Methods and functions:
- Example: `bootstrap`, `someMethod`
2015-08-21 23:13:31 -04:00
- Should be camel case with first lower case
Constants
- Example: `CORE_DIRECTIVES`
- Should be all uppercase with SNAKE_CASE