Допустимо ли сокращать названия переменных до 1 буквы или комбинации символа + буквы?

Question

[historydev]

Сейчас я юзаю snake case + полное название переменной, это даёт мне возможность без проблем понять что происходит в коде спустя время, как и думаю другим будущим разработчикам. Однако я видел достаточно много реализаций разных алгоритмов где используются 1-2 буквы от силы, при этом понятно если прочитать код что в нём происходит.
Отсюда второй вопрос: Если можно так делать, каким принципам следовать, где почитать о них?

private _sender_id?: string;
	private _receiver_id?: string;
	private _peer_connection?: RTCPeerConnection;
	private _local_media_stream?: MediaStream;
	private _remote_media_stream?: MediaStream;
	private _is_call_creator: Boolean = false;
	private _socket_input_name: string = 'p2p_user_media_message';
	private _sender_ready: Boolean = false;
	private _receiver_ready: Boolean = false;

Comments

[Сергей delphinpro]

А для чего всё это?

[historydev]

Сергей delphinpro, как понять?

[Сергей delphinpro]

Владимир, какой практический смысл в сокращении переменных до одного-двух символов?

[historydev]

Сергей delphinpro, вопрос хороший, а вы как считаете, его нет?

[Сергей delphinpro]

Владимир, Есть один – уменьшение объема файла для клиентского кода.
Но этим должен заниматься не программист, а минификатор на этапе развертывания.

[historydev]

Сергей delphinpro, фронт ангуляр вебпаком вроде собирает, там все переменные сокращаются?

[Сергей delphinpro]

Владимир, в режиме production делается оптимизация.

[historydev]

Сергей delphinpro, принял, спасибо

Answer 1

[Василий Банников]

Моё мнение - если тебе смысл переменной не очевиден, то нужно делать полноценное имя переменной.

Короткое, например, имеет смысл для параметра в лямбде (array.filter(x => x % 2 === 0)) или в какой-нибудь функции наподобие

function sum(a, b) {
 return a+b;
}

Если тебе к твоей однобуквенной переменной нужно ещё и комментарий писать, который её расшифрует - значит переменная точно не должна быть однобуквенной.

В том примере кода, который у тебя есть в вопросе, ничего нельзя сократить.

Экономить ресурс нажатий на кнопки клавиатуры не надо, как и не надо экономить буквы на экране.

Answer 2

[rPman]

Да

Первопричина правил и ограничений в том чтобы облегчить поддержку в будущем, только так и никак иначе. Если 'нарушение' каких либо guidelines не мешают этой главной задаче (и может даже помогают) - нарушайте.

Это не закон а рекомендация!

В конечном счете важен результат а не процесс (хотя бывают исключения).

Comments

[historydev]

Мне было бы тяжело скорее всего дебажить код, спустя время, в котором по букве на переменной, как можно облегчить задачу? Я бы примерно так поступил:

type ID = string;

interface UserModel { i: ID; fn: FirstName; ln: LastName }

private s?:string; // Sender ID

[Василий Банников]

Владимир,

type ID = string;

Это прикольно.

interface UserModel { i: ID; fn: FirstName; ln: LastName }

Это нет.

private s?:string; // Sender ID

И в чём однобуквенного поля, если ты комментарием поясняешь?

[rPman]

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

/** Sender ID */
private s?:string;

или любой другой стандарт документирования кода, который поддерживает твоя ide

[historydev]

Василий Банников, чтобы самому не забыть что там вообще находится, я спустя время читаю свой код, и только по названиям переменных вспоминаю что и где используется, и зачем

[historydev]

rPman, а как с остальными ide? Есть какой-то общепринятый стандарт который работает везде? Я использую compodoc для доков под приложение своё на ангуляре

[Василий Банников]

Владимир, Да, это стандартный формат документации, который понимают все инструменты

[historydev]

Василий Банников, вот такой?

/** Sender ID */

[historydev]

Василий Банников, круто! Спасибо

[Василий Банников]

Владимир, https://jsdoc.app/

[historydev]

Василий Банников, спасибо!

[VolgaVolga]

/** Sender ID */

Самодокументируемый код лучше.

[Алексей Уколов]

только по названиям переменных вспоминаю

Кажется, что это и есть ответ на поставленный вопрос.

[historydev]

Алексей Уколов, но ведь jsDoc лучше в разы, можно открыть доки и посмотреть, а не в коде копаться, не так ли? Я открывал некоторые файлы фреймворков и там большие разделы с комментариями

[Алексей Уколов]

Нет, JsDoc не лучше в разы. Комментарии устаревают, а код - нет. Они дополняют друг друга, но первичен, имхо, код.

открывал некоторые файлы фреймворков

Много вы там однобуквенных переменных видели?

private s?:string; // Sender ID

Вот реально, зачем это? Какой смысл здесь сокращать название свойства, что вы от этого получите кроме а) необходимости писать ещё и комментарий (т.е. увеличивать объём работы) и б) необходимость потом к этому комментарию всегда обращаться, когда натолконётесь на это свойство (т.е. увеличивать объём работы)? Вы попробуйте себе на эти вопросы ответить.