ankidroid / ankidroid/Anki-Android
discussion: Document & enforce naming conventions [layouts/standard variables]
- Lingua principale
- Kotlin
- Stelle
- 11.8k
- Fork
- 2.9k
- Merge medio
- 2g 3h
- PR unite (30g)
- 171
Descrizione
From @BrayanDSO
> Now we are using `ViewBinding`, I believe that we should have some documented naming convention for files/ids/constants
> An [example](https://github.com/AnilFurkanOkcun/Android-Naming-Guide) found by googling "android naming guide"
>
> some things I find mostly agreeable:
> **Layouts:**
> Activity -> `activity_` ✅
> Fragment -> `fragment_` ✅
> View -> `view_` ✅
> Dialog -> `dialog_` ✅
> **Constants names** (may need tweaks):
> Fragment arg -> `ARG_` or `ARGUMENT_`
> Intent extra -> `EXTRA_`
> Pref key -> `PREF_`
> Intent action -> `ACTION_`
----
> I believe that it is feasible to add a rule to most of them
> we probably should start with the rules, so it automatically checks what to fix
> the constants shouldn't be hard
> the layout files may need some creativity
----
Source: https://discord.com/channels/368267295601983490/882228005504696350/1452299757073731778
* ViewBindings: #11116
----
EDIT: Table of agreed values
| **Usage** | **Prefix** |
|-------------------------------------|------------|
| Fragment Argument | `ARG_` |
| Intent Extra (generic) | `EXTRA_` |
| Pref key | `PREF_` |
| Intent Action | `ACTION_` |
| Saved Instance State | `STATE_` |
| Fragment Request API | `REQUEST_` |
| Fragment Request API Result bundle | `RESULT_` |
Guida per i contributori
Apri la guida per i contributori
Valutazione
Questa issue non è ancora stata valutata.