3482
правки
Изменения
м
Нет описания правки
Существуют различные подходы к именованию функций и переменных. Но все они содержат общие рекомендации:
* Названия должны быть понятны и осмысленны: {{Inline-<code|>colMeans|lang="rsplus"}}</code>, {{Inline-<code|>read.table|lang="rsplus"}}</code>;
* Названия не должны быть слишком длинными или слишком короткими, что могли бы затруднить их понимание или восприятие;
* Не использовать имена уже используются в R или популярных пакетах. Для проверки уже используемых имён можно использовать функции {{Inline-<code|>find()|lang="rsplus"}} </code> и {{Inline-<code|>apropos()|lang="rsplus"}}</code>;
Можно выделить несколько подходов к именованию функций и переменных:
* alllowercase (слитное написание, все символы в нижнем регистре, без разделителей). Широко используется в MATLAB. Примеры: {{Inline-<code|>searchpaths|lang="rsplus"}}</code>, {{Inline-<code|>searchpaths|lang="rsplus"}}</code>;* period.separated (все символы в нижнем регистре с разделителями в виде точек). Используется только в R. Примеры: {{Inline-<code|>as.numeric|lang="rsplus"}}</code>, {{Inline-<code|>read.table|lang="rsplus"}}</code>, {{Inline-<code|>data.frame|lang="rsplus"}}</code>;* underscore_separated (все символы в нижнем регистре с разделителями в виде нижних подчёркиваний). Используется дл именования переменных и функций в C++, Perl, Ruby. Примеры: {{Inline-<code|>package_version|lang="rsplus"}}</code>, {{Inline-<code|>seq_along|lang="rsplus"}}</code>;* lowerCamelCase (слитное написание, первый символ в нижнем регистре, начало каждого составного слова в верхнем регистре). Используется во многих языках программирования. Примеры: {{Inline-<code|>colMeans|lang="rsplus"}}</code>, {{Inline-<code|>suppressPackageStartupMessage.|lang="rsplus"}}</code>;* UpperCamelCase (слитное написание, первый символ в верхнем регистре, начало каждого составного слова в верхнем регистре). Используется во многих языках программирования. Примеры: {{Inline-<code|>Vectorize|lang="rsplus"}}</code>, {{Inline-<code|>NextMethod|lang="rsplus"}}</code>;
В различных руководствах приводятся разные рекомендации. Как мы уже отмечали, гораздо более важно придерживаться единого стиля при написании кода. В исходном коде R преимущественно используются стили lowerCamelCase, period.separated и underscore_separated. При этом period.separated, как уже отмечалось выше, используется в основном для создания функций для обработки S3 классов.
# Комментарий, содержащий информацию об авторе;
# Комментарий, содержащий информацию о содержании и назначении скрипта;
# Импорт пакетов и скриптов - вызов {{Inline-<code|>library()|lang="rsplus"}} </code> и {{Inline-<code|>source()|lang="rsplus"}}</code>;
# Объявления функций:
# Выполнение основный выражений.
