Много действий - одна строчка или как выбрать название функции

[BiZaJe]

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

ЧТО ТАКОЕ ФУНКЦИЯ?​

Функция - это набор команд для выполнения какого-то действия много раз. Т.е если вам надо надо выполнить одну и ту же задачу много раз, и чтобы не писать бесконечное количество однотипного кода, достаточно написать одну функцию чтобы избавиться от дублирования кода.
Даже если вы совершите ошибку, уходит нужна исправлять это во всем коде, а достаточно будет исправить это всего лишь в одном месте.

ВЫБОР НАЗВАНИЯ ДЛЯ ФУНКЦИИ​

Чтобы функция несла правильный смысл обязательно ей нужно давать правильное название. Для того, чтобы дать правильное имя, нужно сначала разобраться, что делает функция и какую роль выполняет в коде.

// Так например функция приветствия игрока

public ShowWelcomeMessage(iPlayer){
    new NamePlayer[33];
    get_user_name(iPlayer, NamePlayer, charsmax(NamePlayer));
    client_print_color(iPlayer, print_team_color, "^4[WELCOME] ^3Приветствуем вас, %s", NamePlayer);
}

Функция несет роль вывода сообщения приветствия игрока т.е ей дано Правильное имя Show - показать, Welcome - Приветствие, Message - сообщение.

// Или получение всей информации об игроке

public GetInfoPlayer(iPlayer){
    new PlayerName[33], PlayerIP[22], PlayerSID[35];
    get_user_name(iPlayer, PlayerName, charsmax(PlayerName));
    get_user_ip(iPlayer, PlayerIP, charsmax(PlayerIP), 1);
    get_user_authid(iPlayer, PlayerSID, charsmax(PlayerSID));
    client_print_color(iPlayer, print_team_default, "^4[INFO] ^3Игрок ^4%s - IP: %d - SID - %d", PlayerName, PlayerIP, PlayerSID);
}

Get - Получить, Info - Информацию, Player - Игрок.

ПРЕФИКСЫ ДЛЯ ФУНКЦИЙ​

Далее будет список префиксов для функций:

• Get - Получить​
• Check - Проверить​
• Set - Установить​
• Calc - Произвести математический расчет​
• Show - Показать​
• Revoke - Отмена действия​
• Open - Открыть​
• Create - создать​
• Exit - Выход​
• Reload - Перезапустить (В основном встречалось с работой с БД)​
• Fwd - Работа с форвардами​
• Task - Выполнение задачи через время​
• Ham/Re/FM/CST/AMX/CSX - Префиксы при использовании модулей (HamSandWIch/ReApi/Cstrike/AmxMod/CSX модуль)​

Также можете предложить свои варианты в комментариях, я обязательно их добавлю.

Давайте понятные имена для своих функций, вдруг когда-нибудь придется работать другим людям с вашим плагином.

 

[d3m37r4]

Давайте понятные имена для своих функция, вдруг когда-нибудь придется работать другим людям с вашим плагином.

Касается товарисча wellasgood сильно. Иди читай.

 

[Minni]

У каждого свое виденье удобства. Мне, например, хуки функций разных модулей удобно именовать, начиная приставкой *fwd_, где * - это часть названия модуля. Пример: refwd_PlayerSpawn_Post или hamfwd_PrimaryAttack_Post. А, еще мне нравится добавлять приставки функциям, в зависимости от их предназначения: task_ИмяФункции, func_ИмяФункции и т.п.

Короче, у каждого свои запары на счёт этого.

 

[BiZaJe]

d3m37r4, Косяк, бывает

5 Сен 2020

Minni, Дополнил, хоть виденье у всех свое, но для начинающих будет лучше. Может хоть как-то, даст толк (Но не факт)

 

[gyxoBka]

Отлично, теперь осталось рассказать про нотацию и dry