Под «Соглашением о хранении» подразумевается практика следования набору правил или указаний при именовании и организации ресурсов хранения, таких как файлы, папки или таблицы базы данных. Эти соглашения помогают поддерживать согласованность, улучшают возможности поиска и улучшают общую организацию данных.
Вот несколько методов, обычно используемых для соглашений о хранении, а также примеры кода на различных языках программирования:
-
Верблюжий случай:
- Описание. Начинайте с заглавной буквы каждого слова, кроме первого, и удаляйте пробелы и разделители.
- Пример (Python):
employeeDetails
,customerOrders
-
Змеиный случай:
- Описание: используйте строчные буквы и разделяйте слова подчеркиванием.
- Пример (JavaScript):
product_name
,order_date
-
Чехол для кебаба:
- Описание: используйте строчные буквы и разделяйте слова дефисами.
- Пример (Ruby):
профиль пользователя
,категория продукта
-
Кейс Паскаля:
- Описание. Начинайте с заглавной буквы каждого слова, включая первое слово, и удаляйте пробелы и разделители.
- Пример (C#):
CustomerDetails
,ProductList
-
Префиксы или суффиксы:
- Описание: добавьте префикс или суффикс, чтобы указать тип или назначение ресурса хранения.
- Пример (Java):
tbl_orders
,img_profile
-
Сокращения:
- Описание: используйте общепринятые сокращения для длинных слов и фраз.
- Пример (PHP):
cust_name
,prod_qty
-
Дата и время:
- Описание. Добавьте в имя ресурса хранилища отметку времени или дату, чтобы указать, когда он был создан или изменен.
- Пример (Python):
log_20240112
,backup_20211231
-
Иерархическая структура:
- Описание. Используйте структуру папок для организации файлов и ресурсов по категориям или уровням иерархии.
- Пример (C++):
/data/customers/
,/images/products/
-
Осмысленные имена:
- Описание. Используйте описательные имена, передающие назначение или содержимое ресурса хранения.
- Пример (JavaScript):
sales_report_q3
,config_settings
-
Версии:
- Описание. Включите номер версии в имя ресурса хранилища, чтобы отслеживать различные итерации или версии.
- Пример (Ruby):
document_v2
,script_v1.1