Как лучше объявлять переменные в Delphi

Категория:

Данную статью решил написать, так как часто в учебниках для начинающих приводятся такие примеры, куски кода с объявлением переменных представлены как "p", "v", "zh" или же показывается именование элементов форм дефолтными значениями: Form1, Form2, Edit1, Edit2, Edit100 и в итоге часто приходится наблюдать, когда попавшиеся программные коды именно так и оформлены. На первый взгляд может показаться, что все и так понятно и нет смысла заморачиваться с придумыванием каких-то имен, но когда пройдет достаточно много времени, то, уже, запуская этот Delphi проект, будет не так легко разобраться даже в собственном коде. А в чужом подавно. Поэтому важно сразу привыкать к правильному написанию переменной.

Что в этом плохого?

  • Код сложно читать и, следовательно, поддерживать;
  • Приводит к дополнительным затратам на предприятии, что является следствием из первого пункта.  Возможно, часто слышали такое выражение: "Проще заново переписать!!!" Вот это и есть такой код;

Что дает хорошо отформатированный код?

  • Проще вспомнить через некоторое время свой проект;
  • Нужно меньше комментариев, так как код начинает нести осмысленную нагрузку;
  • Другие программисты смогут достаточно легко поддерживать данный программный код.

Пример кода с переменными достатоно хорошего качества:

Пример правильного наименования переменных в проекте Delphi

Как видно из примера, это функция называется exportInWord с передаваемым типом данных TADOQuery, и что она принадлежит классу формы с наименованием frmAnswerState. Даже не читая комментариев (а они тут и не нужны) становится понятно, что здесь идет вывод статистики по ответам в MS Word. Также следуя дальше по коду к переменным, видно, что достаточно понятно для чего они и уже работая в области кода между begin и end, будет вполне легко ориентироваться в подобном коде.

Заключение

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