ankidroid / ankidroid/Anki-Android

discussion: Document & enforce naming conventions [layouts/standard variables]

Abierto
#19,896 10 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Kotlin
Estrellas
11.8k
Forks
2.9k
Merge medio
2 d 3 h
PR fusionados (30 d)
171

Descripción

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_` |

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.