Соглашение об именовании схемы схемы mongodb
Итак, у меня есть то, что называется
exports.create = function(projectJSON){
var project = new ProjectModel({
id : projectJSON.id,
projectName : projectJSON.projectName ,
authorName : projectJSON.authorName,
firstPostDate : projectJSON.firstPostDate
})
}
Правильно ли указано выше соглашение об именах для многословного элемента firstPostDate
(верблюжий регистр), или они должны быть разделены firstPostDate
_
в нижнем регистре?
Я вижу, что другие блоги предпочитают, чтобы это было в маленьких заглавных буквах..
РЕДАКТИРОВАТЬ:
Также я прочитал, что элементы должны быть единственного числа вместо множественного числа, то есть:
'comment' instead of 'comments' for a blog schema design
Ответы
Ответ 1
Я использую Руководство по стилю Google JSON, и они предлагают использовать camelCase i.e. firstPostDate. Ниже приведен фрагмент раздела
Формат имени имени
Имена свойств должны соответствовать следующим рекомендациям:
- Имена свойств должны иметь значащие имена с определенной семантикой.
- Имена свойств должны быть привязаны к верблюду, строки ascii.
- Первым символом должен быть буква, знак подчеркивания (_) или знак доллара ($).
- Последующие символы могут представлять собой букву, цифру, знак подчеркивания или знак доллара.
- Задержанные ключевые слова JavaScript следует избегать (список зарезервированных ключевых слов JavaScript можно найти ниже).
В этих рекомендациях отражены рекомендации по именованию идентификаторов JavaScript. Это позволяет JavaScript-клиентам получать доступ к свойствам с помощью точечной нотации. (например, result.thisIsAnInstanceVariable). Здесь приведен пример объекта с одним свойством:
{
"thisPropertyIsAnIdentifier": "identifier value"
}
Ответ 2
Сокращение имен полей не требуется.
Отметьте docs:
Сокращение имен полей снижает выразительность и не обеспечивает значительная выгода для более крупных документов и не вызывает серьезной озабоченности. Более короткие имена полей не уменьшают размер индексов, поскольку индексы имеют предопределенную структуру. В вообще нет необходимости использовать короткие имена полей.
Ответ 3
Соглашение об именах для коллекции.
Чтобы назвать коллекцию, необходимо принять несколько мер предосторожности:
-
Коллекция с пустой строкой ""
не является допустимым именем коллекции.
-
Имя коллекции не должно содержать нулевой символ, поскольку оно определяет имя конца коллекции.
-
Название коллекции не должно начинаться с префикса "system". так как это зарезервировано для внутренних коллекций.
-
Было бы хорошо не указывать символ $
в имени коллекции, так как различные драйверы, доступные для базы данных, не поддерживают $
в имени коллекции.
Для получения дополнительной информации, пожалуйста, проверьте ссылку: http://www.tutespace.com/2016/03/schema-design-and-naming-conventions-in.html