Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Coding Conventions to match Compose conventions #4154

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update Coding Conventions to match Compose conventions #4154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/topics/coding-conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,12 +181,11 @@ class MyTestCase {
### Property names

Names of constants (properties marked with `const`, or top-level or object `val` properties with no custom `get` function
that hold deeply immutable data) should use uppercase underscore-separated ([screaming snake case](https://en.wikipedia.org/wiki/Snake_case))
names:
that hold deeply immutable data) should use upper camel case names:

```kotlin
const val MAX_COUNT = 8
val USER_NAME_FIELD = "UserName"
const val MaxCount = 8
val UserNameField = "UserName"
```

Names of top-level or object properties which hold objects with behavior or mutable data should use camel case names:
Expand All @@ -201,8 +200,11 @@ Names of properties holding references to singleton objects can use the same nam
val PersonComparator: Comparator<Person> = /*...*/
```

For enum constants, it's OK to use either uppercase underscore-separated names ([screaming snake case](https://en.wikipedia.org/wiki/Snake_case))
(`enum class Color { RED, GREEN }`) or upper camel case names, depending on the usage.
Enum constants should also use upper camel case names:

```kotlin
enum class Color { Red, Green }
```

### Names for backing properties

Expand Down
Loading