Імена процедур і функцій
Verdana; 9.5pt; "1. Правильний вибір імен процедур і функцій дуже важливий для підвищення читабельності коду. У більшості випадків вдало вибране ім'я процедури в поєднанні з правильно підібраними іменами параметрів позбавляють необхідності якось додатково її описувати. У низці випадків складнощі у виборі імені процедури та (або) її параметрів свідчать про неправильну архітектуру програмного коду. І навпаки, якщо "самодокументоване" ім'я вигадати легко, отже процедуру спроєктовано правильно.
1. Правильний вибір імен процедур і функцій дуже важливий для підвищення читабельності коду. У більшості випадків вдало вибране ім'я процедури в поєднанні з правильно підібраними іменами параметрів позбавляють необхідності якось додатково її описувати. У низці випадків складнощі у виборі імені процедури та (або) її параметрів свідчать про неправильну архітектуру програмного коду. І навпаки, якщо "самодокументоване" ім'я вигадати легко, отже процедуру спроєктовано правильно.
Див. також: Опис процедур і функцій
2. Імена процедур, функцій і формальних параметрів слід утворювати від термінів предметної області таким чином, щоб з імені було зрозуміло призначення. Слід прагнути до того, щоб імена були "промовистими" (документували самі себе).
Наприклад, неправильно:
Функція ВиконатиПеревірку(Параметр1, Рекв, ТЗ) Функція ОтриматиМасивиРеквізитів(ГосподарськаОперація,МасивУсіхРеквізитів,МасивРеквізитівОперації)
Правильно:
Функція РеквізитОбєктаЗаданогоТипу(Обєкт,ІмяРеквізиту,ТипЗначення) Функція ЗаповнитиІменаРеквізитівЗаГосподарськоюОперацією(ГосподарськаОперація,ІменаУсіРеквізити,ІменаРеквізитиОперації)
3. Імена слід утворювати шляхом видалення пробілів між словами. При цьому кожне слово в імені пишеться з великої літери. Прийменники та займенники з однієї літери також пишуться великими літерами.
|
Методична рекомендація (корисна порада) 4. Не рекомендується в назвах процедур і функцій описувати типи прийнятих параметрів та (або) значень, що повертаються. Наприклад, неправильно: Функція ОтриматиМасивРолейЗПравомДодавання() Функція ОтриматиСтруктуруДодатковихНалаштувань() Правильно: Функція ІменаРолейЗПравомДодавання() Функція ДодатковіНалаштування() Ця рекомендація справедлива в більшості випадків за рідкісним винятком, коли без опису типу значення, що повертається, не зрозуміло призначення самої процедури або функції. 5. Імена процедур у загальному випадку слід утворювати від неозначеної форми дієслова, від суті виконуваної дії, наприклад: Процедура ЗавантаженняКонтрагента() Правильно: Процедура ЗавантажитиКонтрагента() 6.1. Імена функцій у загальному випадку слід утворювати від опису значення, що повертається. Неправильно: Функція ОтриматиПовнеІмяКористувача() Функція СтворитиПараметриЗаповненняЦінПостачальника() Функція ВизначитиДатуПочаткуСеансу() Правильно: Функція ПовнеІмяКористувача() Функція НовіПараметриЗаповненняЦінПостачальника() Функція ДатаПочаткуСеансу() 6.2. Якщо функція призначена для створення будь-якого об'єкта, то рекомендується в її імені використовувати слово "Новий". Наприклад, Функція ДодатиПолеФорми() Функція СтворитиЕлементДовідникаФайли() Функція ОтриматиТаблицюКоманд() Правильно: Функція НовеПолеФорми() Функція НовийЕлементДовідникаФайли() Функція НоваТаблицяКоманд() 6.3. Якщо функція виконує перевірку якоїсь умови, то її ім'я рекомендується починати зі слова "Це" або використовувати дієприкметники. Функція ПеревіритиПроведеністьДокумента() Функція ПеревіритиЗмінуРеквізитівДокумента() Функція ЗовнішнєЗавдання() Правильно: Функція ДокументПроведено() Функція РеквізитиДокументаЗмінено() Функція ЦеЗовнішнєЗавдання() 6.4. В імені функції рекомендується використовувати дієслова в неозначеній формі в тих випадках, коли для розуміння призначення функції важливо, яким чином було отримано значення, що повертається. Наприклад: Функція ВибратиДаніЗаПравилом(Правило,КористувацькіНалаштування) Функція ПеретворитиДаніЗаПравилом(НабориДаних,ПараметриПеретворення 6.5. Якщо виконання функції передбачає насамперед будь-яку дію, і при цьому повернення значення не є її основним завданням (наприклад, це ознака успішно виконаної дії), то імена таких функцій слід утворювати від неозначеної форми дієслова, як і для процедур. Функція ДозволитиРедагуванняРеквізитівОбєкта(Форма) |