mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-24 21:00:13 +01:00
Move variable naming to its own section. (#7307)
My understanding is that `auto` is encouraged even when there's no applicable naming convention for the variable, and that suffixes like `_id` are encouraged where applicable, even if the type is explicit, so there's really no connection between the two policies.
This commit is contained in:
@@ -14,12 +14,13 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
- [Baseline](#baseline)
|
||||
- [Carbon-local guidance](#carbon-local-guidance)
|
||||
- [General naming rules](#general-naming-rules)
|
||||
- [Variable names](#variable-names)
|
||||
- [File names](#file-names)
|
||||
- [Syntax and formatting](#syntax-and-formatting)
|
||||
- [Line comments](#line-comments)
|
||||
- [Initialization](#initialization)
|
||||
- [Passing addresses](#passing-addresses)
|
||||
- [Naming variable types and the use of `auto`](#naming-variable-types-and-the-use-of-auto)
|
||||
- [Use of `auto`](#use-of-auto)
|
||||
- [Copyable and movable types](#copyable-and-movable-types)
|
||||
- [Static and global variables](#static-and-global-variables)
|
||||
- [Foundational libraries and data types](#foundational-libraries-and-data-types)
|
||||
@@ -82,6 +83,14 @@ serves to simplify it.
|
||||
- For abbreviations, there is a list of
|
||||
[common toolchain abbreviations](/toolchain/docs/idioms.md#abbreviations-used-in-the-code-aka-carbon-abbreviation-decoder-ring).
|
||||
|
||||
### Variable names
|
||||
|
||||
When naming variables, we typically suffix `_id` for ID types. When needed, we
|
||||
can also resolve ambiguity by referring to the full type name in the variable
|
||||
name; for example, if there's a `ClassId`, `InstId`, and `TypeId` for the same
|
||||
class entity, we might call these `class_id`, `class_inst_id`, and
|
||||
`class_type_id`. Similarly, we might call an `Inst` `class_inst`.
|
||||
|
||||
### File names
|
||||
|
||||
- Always use `snake_case` for files, directories, and build system rules.
|
||||
@@ -207,7 +216,7 @@ the following cases applies:
|
||||
};
|
||||
```
|
||||
|
||||
### Naming variable types and the use of `auto`
|
||||
### Use of `auto`
|
||||
|
||||
We generally use `auto` for most local variables when a type can be inferred,
|
||||
except for primitive types such as `bool` and `int`. It is not required to use
|
||||
@@ -217,12 +226,6 @@ type would be obscure and can not be explained with the variable name. Function
|
||||
parameters generally name the type of each parameter, though lambdas may use
|
||||
`auto` if it's helpful.
|
||||
|
||||
When naming variables, we typically suffix `_id` for ID types. When needed, we
|
||||
can also resolve ambiguity by referring to the full type name in the variable
|
||||
name; for example, if there's a `ClassId`, `InstId`, and `TypeId` for the same
|
||||
class entity, we might call these `class_id`, `class_inst_id`, and
|
||||
`class_type_id`. Similarly, we might call an `Inst` `class_inst`.
|
||||
|
||||
### Copyable and movable types
|
||||
|
||||
- Types should have value semantics and support both move and copy where
|
||||
|
||||
Reference in New Issue
Block a user