chore: update NAMING.md with TypeScript conventions

This commit is contained in:
Misko Hevery 2015-08-26 11:48:09 -07:00
parent 3bb27deecc
commit e41d7451bf
1 changed files with 4 additions and 3 deletions

View File

@ -1,7 +1,8 @@
Naming Conventions in Angular2 Naming Conventions in Angular2
--- ---
In general Angular2 should follow Java naming conventions. In general Angular2 should follow TypeScript naming conventions.
See: https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines
Classes: Classes:
@ -9,13 +10,13 @@ Classes:
- Camel case with first letter upper-case - Camel case with first letter upper-case
- In general prefer single words. (This is so that when appending `Proto` or `Factory` the class - In general prefer single words. (This is so that when appending `Proto` or `Factory` the class
is still reasonable to work with.) is still reasonable to work with.)
- Should not end with `Impl` or any other word which describes a specific implemenation of an - Should not end with `Impl` or any other word which describes a specific implementation of an
interface. interface.
Interfaces: Interfaces:
- Follow the same rules as Classes - Follow the same rules as Classes
- Should not have `I` or `Interface` in the name or any other way of identifing it as an interface. - Should not have `I` or `Interface` in the name or any other way of identifying it as an interface.
Methods and functions: Methods and functions: