// Лошо именуване на променливи
var s= 0 // заплата на служител
var n= 0 // име на служител

// Наименуване на лоши функции
fun salary()
fun name()

// Лошо именуване на класове за получаване на потребителски данни
class EmployeeInfo()

// Наименуване на променливи с най-добри практики
var employeeSalary = 0
var employeeName= “”

// Наименуване на функции с най-добри практики
fun getEmployeeName()
fun setEmployeeName()

// Наименуване на класове с най-добри практики за получаване на потребителски данни
class Employee()

Когато именувате функция, променлива или клас, трябва да имате предвид следните неща:

  • Изберете дума със значение (осигурете някакъв контекст)
  • Името трябва да е описателно, кратко и разбираемо.
  • Избягвайте общи имена (като tmp)
  • Прикрепете допълнителна информация към име (използвайте суфикс или префикс)
  • Не правете имената си твърде дълги или твърде къси
  • Използвайте последователно форматиране
  • Избягвайте да използвате едно и също име за различни функции, променливи или класове.
  • Класовете трябва да използват PascalCase, докато променливите и функциите трябва да използват camelCase.

Още пример:

// bad
var dogname = "Droopy"
// bad
var dog_name = "Droopy"
// bad
var DOGNAME = "Droopy"
// bad
var DOG_NAME = "Droopy"
// bad
var d = "Scooby-Doo"
// bad
var name = "Scooby-Doo"

// good
var dogName = "Scooby-Doo"
// good
var dogName = "Droopy"

// bad
var bark = false
// good
var isBark = false

// bad
var ideal = true
// bad
var owner = true
// good
var hasOwner = true
// good
var areIdeal = true

За константна променливаможете да използвате главни букви. Например:

//kotlin
val LEG = 4
val TAIL = 1
val MOVABLE = LEG + TAIL
//more than one world
val DAYS_UNTIL_TOMORROW = 1

Променливите на указателятрябва да се добавят с „p“ и да се постави звездичката „*“ близо до името на променливата вместо типа на указателя.

int *Page, адрес; // Тук само pAge е указателна променлива

Референтните променливи трябва да се добавят с „r“. Това помага да се направи разлика между метода, който връща модифицируем обект, и същия метод, който връща немодифицируем обект.

Статичните променливи трябва да се добавят с ‘s’.

статичен int sCount;

За функция:

Трябва да използвате описателни съществителнии глаголикато представки. Например, ако декларираме функция за извличане на име, името на функцията трябва да бъде getName.

// bad
function name(dogName, ownerName) { 
  return '${dogName} ${ownerName}';
}
// good
function getName(dogName, ownerName) { 
  return '${dogName} ${ownerName}';
}

Функцията трябва ясно да подсказва какво прави. Името на всеки метод/функция трябва да започва с глагол.

  • Суфиксите понякога са полезни. Например,
  • Брой -текущият брой на брояча.
  • Ключ -ключовата стойност.
  • Префиксите понякога са полезни. Например,
  • получи-получи стойност.
  • Задана - зададена стойност.

//java

int getValue();

Първият знак на имената на аргументите на функция/метод трябва да е с малки букви. Всяка дума също трябва да започва с главна буква.

За клас:

Основната разлика между имената на функции и класове е, че трябва да използваме Pascal caseза имена на класове. Използвайте съществителнокато име на клас. Първият знак в името на класа трябва да е с главни букви.

//java scripts
class DogCartoon { 
  constructor(dogName, ownerName) { 
    this.dogName = dogName; 
    this.ownerName = ownerName; 
  }
}

class FingerprintScanner
//java scripts
var cartoon = new DogCartoon('Scooby-Doo', 'Shaggy');

Ping me: Linkedin