有一条好的软件设计原则叫CoC(Convention over Configuration),即惯例优于配置原则,详见:wiki

项目需要一个好的命名规范,这样可以大大降低学习成本以及查找成本,通过对文件名以适当的形式命名,可以非常快速的知道这个文件的类型,作用以及用来实现的功能。在本项目开发的过程中,主要参考了两个命名规范:一个是github上关于angularjs的规范,一个是google自己的angularjs规范,一般他们都叫style guide:

https://github.com/mgechev/angularjs-style-guide

https://google.github.io/styleguide/angularjs-google-style.html


下面具体说一下,对于angularjs项目主要有两种:1)如何命名文件名,2)如何命名angularjs各种模块,当然了还有许多更详细的方面,有兴趣的请仔细阅读上面给出的两个参考。

(一)文件名

总体原则:英文全部小写,用‘-’进行单词分割,这样比较利于人眼阅读,比如:disk-creation.html,add-disk-dialog.html。其实最好全用名词性短语起名,但是英语水平有限,用动宾短语形式也可以接受。

还有就是一个文件代表一个angularjs模块,尽量不要在一个文件里写多个模块,比如在一个文件里写多个controller,这样非常不好查找,不利于后来新人快速学习。

  • controller模块以“.controller”结尾,例如server.controller.js,add-disk.controller.js
  • service模块以“.service”结尾,例如:server.service.js
  • module模块以“.module”结尾,例如app.module.js,app-hardware.module.js
  • 路由文件以“.routes”结尾,例如hardware.routes.js,这里看项目对路由是如何处理的,根据自己项目需要
  • directive模块以“.directive”结尾,例如menu-list.directive.js,如果一个文件里写了多个小directive,用复数(directives)形式结尾
  • filter模块以“.filter”结尾,同理多个filter写在一个文件的用filters结尾
  • 压缩过的模板文件用“.templates”结尾,例如app.templates.js
上面应该覆盖了主要的angularjs各种模块,还有其它的可以根据这个原则处理。这里说一下为什么会把多个directive放在一个文件里,因为有的directive比较小,可能就5-6行代码,如果一个directive写一个文件,会造成文件数的快速增长,虽然发布的时候可以都压缩在一起,但维护起来仍然比较繁琐。所以可以折中一下,根据自己的项目安排即可。

(二)angularjs模块名

总体原则:驼峰方式命名
  • Controller名称以Ctrl结尾,开头单词大写,因为angularjs中的Controller是个类概念,在使用的时候会被实体化,所以遵循类的命名范式。例如ServerCtrl,ServerCreationCtrl
  • Service名称以Srv结尾,开头单词小写,因为angularjs中的Service是个单例概念,不需要被实例化。例如serverSrv
  • Directive没有做强制要求,能描述功能就可以,但其实开头应该加上项目名称简写的前缀,这样在使用的时候非常容易区别到底是自己写的还是导入第三方库的directive,例如项目叫console,应该以cs开头命名,就像angularjs内置的directive都以ng打头一样
  • Filter没有强制要求,可以参考上面的两个style里有啥说法
  • Module的名称,本项目中都以小写命名了,并且用点分割父子关系,比如hardware子模块叫app.hardware
  • Utils,这里所谓的Utils还是Service,就是叫习惯了,所以有些通用的功能需要封装的,就叫Utils了。比如httpUtils,domUtils。当然了文件名还是以“.service.js”结尾,如果觉得会有困扰,根据自己的需求,可以改成Srv结尾
上面大概介绍了一下本人感觉还可以的命名方式,好不好可以根据自己的项目进行调整,只要项目成员觉得易懂,容易查找就可以。至于具体的js代码怎么写,上面的两个参考style中也都有介绍,比如是用:
module.controller('diskCreationCtrl',['$scope','$uibModalinstance',function($scope,$uibModalinstance){}])
还是用$inject形式,就仁者见仁智者见智的问题了。

AngularJS实际项目应用——命名规范概览的更多相关文章

  1. Android Studio是否支持用于Android UI设计的AngularJS?

    我对AndroidStudio有疑问:AS在设计XML文件时是否支持AngularJS代码,例如:对于小动画或效果?

  2. android – 如何使用ClientID和ClientSecret在Phonegap中使用Angularjs登录Google OAuth2

    我正尝试使用Angularjs(使用IonicFramework)通过GoogleOAuth2从我的Phonegap应用程序登录.目前我正在使用http://phonegap-tips.com/articles/google-api-oauth-with-phonegaps-inappbrowser.html进行登录.但是当我使用Angular-UI-RouterforIonic时,它正在创建非常

  3. 利用require.js与angular搭建spa应用的方法实例

    这篇文章主要给大家介绍了关于利用require.js与angular搭建spa应用的方法实例,文中通过示例代码给大家介绍的非常详细,对大家的理解和学习具有一定的参考学习价值,需要的朋友们下面跟着小编来一起看看吧。

  4. 详解Angular动态组件

    本文主要介绍了Angular动态组件,对此感兴趣的同学,可以亲自实验一下。

  5. 详解如何使用webpack+es6开发angular1.x

    本篇文章主要介绍了详解如何使用webpack+es6开发angular1.x,具有一定的参考价值,有兴趣的可以了解一下

  6. angular2系列之路由转场动画的示例代码

    本篇文章主要介绍了angular2系列之路由转场动画的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

  7. 一种angular的方法级的缓存注解(装饰器)

    本篇文章主要介绍了一种angular的方法级的缓存注解(装饰器),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

  8. 动手写一个angular版本的Message组件的方法

    本篇文章主要介绍了动手写一个angular版本的Message组件的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

  9. angular forEach方法遍历源码解读

    这篇文章主要为大家详细了angular forEach方法遍历源码,forEach()方法用于遍历对象或数组,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

  10. Angular的MVC和作用域

    本文主要Angular的MVC和作用域进行详细分析介绍,具有一定的参考价值,下面跟着小编一起来看下吧

随机推荐

  1. Angular2 innerHtml删除样式

    我正在使用innerHtml并在我的cms中设置html,响应似乎没问题,如果我这样打印:{{poi.content}}它给了我正确的内容:``但是当我使用[innerHtml]=“poi.content”时,它会给我这个html:当我使用[innerHtml]时,有谁知道为什么它会剥离我的样式Angular2清理动态添加的HTML,样式,……

  2. 为Angular根组件/模块指定@Input()参数

    我有3个根组件,由根AppModule引导.你如何为其中一个组件指定@input()参数?也不由AppModalComponent获取:它是未定义的.据我所知,你不能将@input()传递给bootstraped组件.但您可以使用其他方法来做到这一点–将值作为属性传递.index.html:app.component.ts:

  3. angular-ui-bootstrap – 如何为angular ui-bootstrap tabs指令指定href参数

    我正在使用角度ui-bootstrap库,但我不知道如何为每个选项卡指定自定义href.在角度ui-bootstrap文档中,指定了一个可选参数select(),但我不知道如何使用它来自定义每个选项卡的链接另一种重新定义问题的方法是如何使用带有角度ui-bootstrap选项卡的路由我希望现在还不算太晚,但我今天遇到了同样的问题.你可以通过以下方式实现:1)在控制器中定义选项卡href:2)声明一个函数来改变控制器中的散列:3)使用以下标记:我不确定这是否是最好的方法,我很乐意听取别人的意见.

  4. 离子框架 – 标签内部的ng-click不起作用

    >为什么标签标签内的按钮不起作用?>但是标签外的按钮(登陆)工作正常,为什么?>请帮我解决这个问题.我需要在点击时做出回复按钮workingdemo解决方案就是不要为物品使用标签.而只是使用divHTML

  5. Angular 2:将值传递给路由数据解析

    我正在尝试编写一个DataResolver服务,允许Angular2路由器在初始化组件之前预加载数据.解析器需要调用不同的API端点来获取适合于正在加载的路由的数据.我正在构建一个通用解析器,而不是为我的许多组件中的每个组件设置一个解析器.因此,我想在路由定义中传递指向正确端点的自定义输入.例如,考虑以下路线:app.routes.ts在第一个实例中,解析器需要调用/path/to/resourc

  6. angularjs – 解释ngModel管道,解析器,格式化程序,viewChangeListeners和$watchers的顺序

    换句话说:如果在模型更新之前触发了“ng-change”,我可以理解,但是我很难理解在更新模型之后以及在完成填充更改之前触发函数绑定属性.如果您读到这里:祝贺并感谢您的耐心等待!

  7. 角度5模板形式检测形式有效性状态的变化

    为了拥有一个可以监听其包含的表单的有效性状态的变化的组件并执行某些组件的方法,是reactiveforms的方法吗?

  8. Angular 2 CSV文件下载

    我在springboot应用程序中有我的后端,从那里我返回一个.csv文件WheniamhittingtheURLinbrowsercsvfileisgettingdownloaded.现在我试图从我的角度2应用程序中点击此URL,代码是这样的:零件:服务:我正在下载文件,但它像ActuallyitshouldbeBook.csv请指导我缺少的东西.有一种解决方法,但您需要创建一个页面上的元

  9. angularjs – Angular UI-Grid:过滤后如何获取总项数

    提前致谢:)你应该避免使用jQuery并与API进行交互.首先需要在网格创建事件中保存对API的引用.您应该已经知道总行数.您可以使用以下命令获取可见/已过滤行数:要么您可以使用以下命令获取所选行的数量:

  10. angularjs – 迁移gulp进程以包含typescript

    或者我应该使用tsc作为我的主要构建工具,让它解决依赖关系,创建映射文件并制作捆绑包?

返回
顶部