honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(style-guide): added the one more why on 02-02 

closes #1473
This commit is contained in:
Shai Reznik 2016-05-23 00:34:44 +03:00 committed by Ward Bell
parent 990a80ec9c
commit 6475b5efab
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
public/docs/ts/latest/guide/style-guide.jade
View File

@ -193,7 +193,7 @@ a(href="#toc") Back to top
.s-rule.do .s-rule.do
:marked :marked
**Do** use dashes to separate words. **Do** use dashes to separate words in the descriptive name.
.s-rule.do .s-rule.do
:marked :marked
@ -201,19 +201,25 @@ a(href="#toc") Back to top
.s-rule.do .s-rule.do
:marked :marked
**Do** use consistent names for all components following a pattern that describes the component's feature then its type. A recommended pattern is `feature.type.ts`. **Do** use consistent type names for all components following a pattern that describes the component's feature then its type. A recommended pattern is `feature.type.ts`.
.s-rule.do .s-rule.do
:marked :marked
**Do** use conventional suffixes for the types including `*.service.ts`, `*.component.ts`, `*.pipe.ts`. Invent other suffixes where desired, but take care in having too many. **Do** use conventional type names including `.service`, `.component`, `.pipe`.
Invent additional type names if you must but take care not to create too many.
.s-why .s-why
:marked :marked
**Why?** Provides a consistent way to quickly identify what is in the file. **Why?** Type names provide a consistent way to quickly identify what is in the file.
.s-why .s-why
:marked :marked
**Why?** Provides a consistent way to quickly find a specific file using an editor or IDE's fuzzy search techniques. **Why?** Make it easy to find a specific file type using an editor or IDE's fuzzy search techniques.
.s-why
:marked
**Why?** Unabbreviated type names such as `.service` are descriptive and unambiguous.
Abbreviations such as `.srv`, `.svc`, and `.serv` can be confusing.
.s-why.s-why-last .s-why.s-why-last
:marked :marked