Является ли хорошей практикой префикс ВСЕХ классов / интерфейсов / функций с помощью аббревиатуры приложения?

Question

Я работаю в проекте Angular, и я хотел бы знать, является ли хорошей практикой префикс для всех классов, интерфейсов и функций с аббревиатурой приложения .

Например, он хорошо стандартизирован для добавления компонентов тегов к акрониму приложения, поэтому он не будет конфликтовать с другими элементами в домене и будет проще для поиска.

Так, например, если мое приложение использует аббревиатуру toh(Тур героев), и у меня есть компонент фильтра, его тег будет <toh-filter>.

Это прекрасно, но хорошая практика - применить это к ALL кодовая? Для всей кодовой базы я имею в виду: все классы, интерфейсы и экспортируемые функции и константы.

Я хотел бы понять Плюсы и минусы и почему это может иметь смысл или нет.

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

Вот несколько примеров (без префикса и с префиксом):

// ./filter.component.ts
@Component() export class FilterComponent {}
@Component() export class TohFilterComponent {}

// ./some.service.ts
export class SomeService {}
export class TohSomeService {}

// ./utils.ts
export function deepCopy() {}
export function tohDeepCopy() {}

export function pipe() {}
export function tohPipe() {}

Заранее спасибо!

Answer 1

Я бы сказал нет.

Когда вы пишете код TS / JS, который разбит на несколько файлов, вы можете выбирать, куда импортировать ваши классы, и даже переименовывать их.

Таким образом, вы можете управлять конфликтами самостоятельно, без необходимости добавлять префикс.

Как вы могли видеть, Angular добавляет суффикс к вашим классам: это связано с их требованием к стилю LIFT, которое говорит о файле / class / var / etc. должен быть найден и идентифицирован очень быстро.

Но для префикса он не нужен, и главное в этом то, что вам придется делать это вручную на каждом написанном вами классе, тогда как его нет. за это.

Итак, подвести итог, нет, не стоит.