Angularjs код / ​​соглашения об именах [закрыто]

162

Кто-нибудь знает, существует ли какая-либо официальная или наиболее приемлемая ссылка на соглашения об именовании Angular, которые мы будем использовать при создании наших приложений?

В Angular есть много различных типов компонентов, таких как фильтры, директивы, сервисы и так далее. Разве вы не согласны с тем, что использование соглашения о присвоении имен в наших приложениях будет иметь смысл?

Например:

Если нам нужно создать новые фильтры, как мы должны называть их как [Something] Filter или filter [Something] или что-то еще?

То же самое касается контроллеров, услуг, директив и так далее.

Другие вещи, которые меня интересуют, это то, должны ли переменные / функции, принадлежащие области действия, иметь специальный префикс или суффикс. В некоторых ситуациях может быть полезно иметь способ отличить их от функций и других (без углового кода).

Dalorzo
источник
2
Я только что нашел этот интересный пост в блоге Angular под названием « Рекомендации по лучшей практике для структуры угловых приложений»
Эдвин Далорсо

Ответы:

158

Посмотрите этот репозиторий GitHub, в котором описаны лучшие практики для приложений AngularJS. Он имеет соглашения об именах для разных компонентов. Это не полный, но это обусловлено сообществом, так что каждый может внести свой вклад.

Тони
источник
Обновление: github.com/mgechev/angularjs-style-guide
M.Octavio
45

Если вы новичок, лучше сначала пройтись по некоторым базовым учебникам, а затем узнать о соглашениях по присвоению имен. Я изучил Angular, некоторые из которых очень эффективны.

Учебники:

  1. http://www.toptal.com/angular-js/a-step-by-step-guide-to-your-first-angularjs-app
  2. http://viralpatel.net/blogs/angularjs-controller-tutorial/
  3. http://www.angularjstutorial.com/

Детали структуры приложения и соглашений об именах можно найти в разных местах. Я просмотрел сотни сайтов и думаю, что они являются одними из лучших:

Раджендра Хабия
источник
33

Для структурирования приложения это одно из лучших руководств, которые я нашел:

Обратите внимание, что структура, рекомендованная Google, отличается от структуры, которую вы найдете во многих начальных проектах, но для больших приложений это намного разумнее.

У Google также есть руководство по стилю, которое имеет смысл использовать, только если вы также используете Closure .


... этот ответ неполон, но я надеюсь, что приведенная выше ограниченная информация будет кому-то полезна.

Гил Бирман
источник
19

Обновление: РУКОВОДСТВО ПО СТИЛЮ теперь в Angular Docs.

////////////////////////////////////////////////// ////////////////////////////////////////////////// ////////////////////////////////////////////////// //////

Если вы ищете авторитетное руководство по стилю для синтаксиса, соглашений и структурирования приложений AngularJS, то сразу приступайте. Стили, содержащиеся здесь, основаны на моем опыте работы с AngularJS, презентациях, учебных курсах и работе в командах.

Цель этого руководства по стилю состоит в том, чтобы предоставить руководство по созданию приложений AngularJS, показывая соглашения, которые я использую, и, что более важно, почему я выбираю их.

- Джон Папа

Вот отличная ссылка (самая последняя и актуальная): AngularJS Style Guide

Сампатх
источник
6

Я начал эту суть год назад: https://gist.github.com/PascalPrecht/5411171

Брайан Форд (член основной команды) написал об этом в блоге: http://briantford.com/blog/angular-bower

А затем мы начали с этой спецификации компонента (которая не совсем полная): https://github.com/angular/angular-component-spec

Со времени последнего ng-conf есть этот документ для лучших практик основной команды: https://docs.google.com/document/d/1XXMvReO8-Awi1EZXAXS4PzDzdNvV6pGcuaF4Q9821Es/pub

Паскаль Прехт
источник