31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
|
---
|
||
|
|
title: Please don't use short variable names
|
||
|
|
date: 2024-01-17
|
||
|
|
permalink: archive/2024/01/17/short-variable-names
|
||
|
|
snippet: |
|
||
|
|
Why use variable names like $k, $v and $i instead of $key, $value and $index? What benefit does it add?
|
||
|
|
tags:
|
||
|
|
- software-development
|
||
|
|
- clean-code
|
||
|
|
---
|
||
|
|
|
||
|
|
When learning to code, one of the most confusing things was using short variable names in documentation and other people's code.
|
||
|
|
|
||
|
|
Things like `$k` and `$v` instead of `$key` and `$value` within loops, `$i` instead of `$index`, or `$e` when working with Exceptions.
|
||
|
|
|
||
|
|
I've also seen slightly better names, such as `$idx` for index or `$ctx` for context.
|
||
|
|
|
||
|
|
But what does this achieve?
|
||
|
|
|
||
|
|
Why not write the full variable name and clarify what it refers to?
|
||
|
|
|
||
|
|
It would be easier to read and understand for anyone reading the code, including Junior Developers and people new to your team or application.
|
||
|
|
|
||
|
|
There are no limitations - at least in the languages I use - to force this, such as a maximum number of characters in a file, so why not write the full variable name?
|
||
|
|
|
||
|
|
The only reason I can think of is to save time by pressing fewer keys, but code is read more than written, so it should be optimised for readability.
|
||
|
|
|
||
|
|
Your tests and CI pipeline don't have a preference.
|
||
|
|
|
||
|
|
The people reading the code will.
|