nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-24 07:44:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Var naming

Browse Source
This commit is contained in:
Aleksey Kladov 2020-06-15 10:33:17 +02:00
parent 017331a53c
commit 5413a2f962
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/dev/README.md
View File

@ -236,6 +236,13 @@ struct Foo {
}
```
## Variable Naming
We generally use boring and long names for local variables ([yay code completion](https://github.com/rust-analyzer/rust-analyzer/pull/4162#discussion_r417130973)).
The default name is lowercased named of the type: `global_state: GlobalState`.
Avoid ad-hoc acronyms and contractions, but use the ones that exist consistently (`db`, `ctx`, `acc`).
The default name for "result of the function" local variable is `res`.
## Preconditions
Function preconditions should generally be expressed in types and provided by the caller (rather than checked by callee):