Выбор эффективных имен функций
Я ищу совет по написанию хорошего имени функции в рамках разрабатываемой веб-страницы. Он написан на PHP, и функция в основном собирает массив данных, содержащих информацию о посещаемости клиента, в музыкальном заведении (например, время, дата, вход и т. Д.). Функция принимает данные массива и возвращает информацию в формате строки, включающей структурирование HTML.
Например:
//function formats array
...
$returnStr = "<span class='bold'>Entrance</span>customerData['entrance']";
Причина, по которой я спрашиваю, состоит в том, что любое имя функции, которое я придумаю, кажется слишком многословным или не совсем ясно, что оно означает. Мне нужно поддерживать много кода, поэтому я стараюсь выбирать эффективные имена, чтобы при повторном посещении кода я мог быстро понять, что происходит.
Любые онлайн-ресурсы или личное понимание будут оценены.
Решение
Там нет черного или белого в этом случае. Но я считаю, что лучшая практика должна быть:
- Логический — Опишите, что делает функция
- Удобно — коротко и точно
Таким образом, вам не придется думать о том, «подождите, как называется функция, которая выполняет X и Y?» и вам не придется писать слишком много кода, например: printMusicVenueFromArray,
И «логический», и «удобный» аспекты являются субъективными и могут отличаться от одного человека к другому, так что пока над вами работает только вы — делайте то, что чувствуете правильно.
Когда у вас есть команда разработчиков, работающих над одним проектом, подумайте о том, чтобы нарисовать некоторые рекомендации раньше.
Начните с описания функции словами, что является вводом, каков вывод.
Рассмотрим другие функции, которые уже существуют в вашем коде с похожими именами (вы не хотите запутаться).
По вашему описанию:
функция в основном собирает массив данных, сохраняя посещаемость
информация о музыкальном заведении (пример времени, даты, входа и т. д.).
функция принимает данные массива и возвращает информацию в формате
строка, включающая структурирование HTML.
вход
массив данных, содержащих информацию о посещаемости клиента на музыкальном объекте
Выход
(вернуть) информацию, отформатированную в виде строки, включающей структурирование HTML.
Обычно, когда я пишу функции, которые возвращают что-то, я начинаю с get, но ваша функция возвращает строку HTML, так что это больше view функция, так что вы можете игнорировать это.
Теперь вы должны подумать о том, что описывает возвращаемую строку наиболее, на мой взгляд, что-то вроде «MusicProfile» или «MusicDetails».
Кстати, ваши цитаты конфликтуют.
Другие решения
Других решений пока нет …