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

[david-allison]

From @BrayanDSO

Now we are using ViewBinding, I believe that we should have some documented naming convention for files/ids/constants
An example 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: Add View Binding #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

[david-allison]

I prefer ARG_ over ARGUMENT_, I'm happy with the rest.

In addition: a savedInstanceState prefix: STATE_

[david-allison]

I feel the first half (Layouts) is non-controversial and we can open this for work immediately.

The constant names will need more discussion, but standardizing these will also produce the most value

We should also determine whether these are only constraints on the constant name, or whether the value should also be constrained

[lukstbit]

For layouts, besides all those, I also used include for layouts that are designed to be used in other layouts, ex: include_toolbar.xml or include_progres.xml. If accepted.

I prefer ARG_ over ARGUMENT_, I'm happy with the rest.

ARG for sure, some of those already have quite long names.

Constants names (may need tweaks):

Keys used for the fragments results apis -> REQUEST_ (usage ex: setFragmentResultListener(REQUEST_EXPORT_SAVE, this) {})

activity_single_fragment_activity is a little verbose

The proper name would be activity_single_fragment.xml.

[david-allison]

Keys used for the fragments results apis -> REQUEST_ (usage ex: setFragmentResultListener(REQUEST_EXPORT_SAVE, this) {})

👍 For the output bundle, we have the choice of RESULT_ or EXTRA_. RESULT_ seems sensible

[lukstbit]

👍 For the output bundle, we have the choice of RESULT_ or EXTRA_. RESULT_ seems sensible

Fine with either, probably leaning towards RESULT_ as well.

Another real issue is the icons names were we are very inconsistent adding all sorts of extras: dimensions(_24), where it's used(_popup_menu), colors(_black) etc.

For them I would just use ic_name and probably add outline/filled as well where it can be applied.

[david-allison]

Also agreed on the icons

• in recent memory: Use more consistent icons for multimedia attachment items #19654