SuperAPI AI 工具集

angularjs

编程与开发

查看项目

更新于 10-16 07:42

技能介绍

用途

本指南是 Google 官方的 AngularJS(Angular 1.x)编码标准,用于帮助团队构建风格一致的 Angular 1.x 应用。它面向需要维护或审查 AngularJS 1.x 代码的开发者,提供统一的命名、结构与写法约定。

注意:本指南针对 AngularJS(Angular 1.x)。如需现代 Angular(2+),请参考 Angular 风格指南。

主要能力

指南以“黄金法则”和具体代码示例的形式,覆盖以下方面:

  • 每个文件只放一个组件,便于维护与测试。
  • 使用 controllerAs 语法,尽量避免直接使用 $scope。
  • 业务逻辑放入服务(service/factory),保持控制器精简。
  • 显式依赖注入,使用数组注解或 $inject。
  • 模块化结构,按功能而非类型组织。
  • 指令仅用于 DOM 操作。
  • 避免使用 $rootScope,共享状态改用服务。

命名约定

指南给出各元素的命名规范与示例:

  • 模块:lowerCamelCase,如 myApp、myApp.users。
  • 控制器:UpperCamelCase + Ctrl,如 UserCtrl、HomeCtrl。
  • 服务/工厂:UpperCamelCase,如 UserService、AuthFactory。
  • 指令:lowerCamelCase,如 myDirective、userCard。
  • 过滤器:lowerCamelCase,如 dateFormat、currencyDisplay。
  • 文件:feature.type.js,如 user.controller.js。

使用方式

指南通过“正确/错误”对照的代码示例说明写法,主要涉及:

  • 控制器:使用 controllerAs 语法,通过 var vm = this 暴露视图模型,并在 $inject 中声明依赖。
  • 服务:以 factory 形式封装业务逻辑,返回包含 getAll、getById、create 等方法的对象。
  • 指令:使用 restrict、scope、templateUrl、controller、controllerAs、bindToController 等配置,仅用于 DOM 操作。
  • 依赖注入:推荐使用 $inject 注解(对压缩安全),不推荐内联数组写法或无注解写法。
  • 模块:每个文件只定义一个模块,按功能拆分为子模块。
  • 模板:在模板中使用 controllerAs(如 UserCtrl as vm),ng-repeat 配合 track by。

常见错误对照

指南列出常见错误及正确做法:

  • 控制器中写业务逻辑 → 移到服务/工厂。
  • 直接使用 $scope → 使用 controllerAs 与 vm 别名。
  • 隐式依赖注入(压缩后会出错)→ 使用 $inject 或数组注解。
  • 控制器中操作 DOM → 使用指令。
  • 所有内容放在一个模块 → 按功能拆分为子模块。
  • 用 $rootScope 共享状态 → 改用服务。
  • 为每次变更都加 watcher → 尽量使用一次性绑定 ::。

适用场景

  • 维护 AngularJS 1.x 应用。
  • 对遗留 Angular 项目进行代码审查。
  • 帮助新成员上手 AngularJS 项目。

安装

npx skills add testdino-hq/google-styleguides-skills/angularjs

完整指南

完整细节、示例与边界情况见 angularjs.md。

限制

本指南仅针对 AngularJS(Angular 1.x),不适用于现代 Angular(2+)。关于收费、价格、平台支持等信息,资料中暂未提供。