// Плохое имя переменных
var s= 0 // зарплата сотрудника
var n= 0 // имя сотрудника

// Плохое название функций
fun pay()
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 является указателем

Ссылочные переменные должны начинаться с 'r'. Это помогает различать метод, возвращающий модифицируемый объект, и тот же метод, возвращающий немодифицируемый объект.

Статические переменные должны начинаться с 's'.

статический int sCount;

Для функции:

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

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

Функция должна четко намекать на то, что она делает. Имя каждого метода/функции должно начинаться с глагола.

  • Иногда полезны суффиксы. Например,
  • Count- текущий счет счетчика.
  • Ключ — значение ключа.
  • Префиксы иногда полезны. Например,
  • получить-получить значение.
  • set-установить значение.

//Джава

int получить значение();

Первый символ имени аргумента функции/метода должен быть строчным. Каждое слово также должно начинаться с заглавной буквы.

Для класса:

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

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

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

Пишите мне: Linkedin