Использование PascalCasing и camelCasing для именования модулей в TypeScript: Сравнение с Java и предпочтения разработчиков

Delphi , Синтаксис , Типы и Переменные

Введение: Вопрос о выборе стиля именования модулей в TypeScript является актуальным, особенно при работе в команде, где используются различные подходы и языки программирования, такие как Java. В данной статье мы рассмотрим аргументы в пользу использования PascalCasing и camelCasing для именования модулей, а также сравним их с практиками, принятыми в Java.

Аргументы в пользу PascalCasing:

1. Соответствие с C# и PHP: Языки C# и PHP используют PascalCasing для именования пространств имен и классов. В TypeScript модуль можно рассматривать как класс с только статическими членами, что делает использование PascalCasing логичным выбором.

typescript module MyLib { export function f1() { } export function f2() { } // ... }

1. Согласованность с TypeScript и JavaScript: Так как TypeScript работает с множеством JavaScript-библиотек и может быть использован кодом на JavaScript, предпочтительно использовать PascalCasing для модулей и классов, а члены - в camelCasing.

```typescript module ExampleModule { export class ExampleClass { public exampleProperty: string;

       public exampleMethod() {
       }
   }

} ```

Важно: константы в TypeScript обычно пишутся ЗАГЛАВНЫМИ БУКВАМИ.

Аргументы в пользу camelCasing:

1. Соответствие Google Style Guide для JSON: В руководстве Google по стилю для JSON указано, что имена свойств должны быть написаны в стиле camelCasing. Однако модуль в TypeScript не является JSON-объектом.

2. Привычка разработчиков Java: В Java используются имена в нижнем регистре, что может влиять на предпочтения разработчиков, привыкших к camelCasing.

Подтвержденный ответ:

В TypeScript принято следовать тем же стандартам, что и в JavaScript. Это означает, что для модулей и классов используется PascalCasing, а для членов - camelCasing. Сохранение согласованности стиля важно, так как он может нести в себе определенное значение и, если стиль не последователен, это может привести к путанице.

Альтернативный ответ:

Внутренние модули в TypeScript - это пространства имен. Следующая версия TypeScript сосредоточена на внешних модулях из ECMAScript 6, которые не являются пространствами имен. Microsoft не опубликовал руководства по именованию внутренних модулей в TypeScript.

Комментарии:

Спасибо за объяснение и исключение для констант. Какие рекомендации по именованию соответствующих файлов? Более распространено ли согласование с символами кода или, например, url_utils.ts просто лучше выглядит в файловой системе по сравнению с UrlUtils.ts? Также шаблоны React-приложений обычно используют PascalCasing только для компонентов, в то время как другие файлы следуют стилю camelCase (index.tsx, setupTests.ts, ...) или даже стилю с использованием дефисов (react-app-env.d.ts).

Заключение:

При выборе стиля именования модулей в TypeScript важно учитывать контекст, в котором будет использоваться код, и предпочтения команды разработчиков. PascalCasing и camelCasing имеют свои преимущества, и выбор между ними зависит от конкретных требований проекта и соглашений внутри команды.

Создано по материалам из источника по ссылке.

Именование модулей в TypeScript с использованием PascalCasing и camelCasing имеет свои особенности и предпочтения, которые могут быть связаны с соглашениями в C#, PHP, JavaScript и Java, а также с привычками и предпочтениями разработчиков.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: Типы и Переменные ::