Почему большинство полей (членов класса) в руководстве по Android начинаются с `m`?

Во многих руководствах по кодированию m используется для обозначения «членов» класса. Поэтому, когда вы программируете, вы можете видеть разницу между локальными переменными и переменными-членами.

Что такое префикс m?

m обозначает переменную-член или элемент данных. Используйте префикс m для закрытых и нестатических полей.

Когда использовать?

private String mCityName;
private float mTemperature;

Когда не использовать?

public static int mFirstNumber;
public static final String mDATABASE_NAME;

Что я делаю?

Лично я им не пользуюсь. Это усложняет код и ухудшает читаемость. Если вы все еще используете Блокнот для кодирования, у меня нет слов, но современные IDE способны выделять и раскрашивать членские и локальные переменные или что-то еще.

Заключение

Использовать? «Да» или «Нет» - ваш личный выбор.

Если это переменные-члены в классах, «m» означает «член». Многие программисты Java делают это, хотя в современных IDE это не нужно, поскольку у вас есть выделение, подсказки при наведении указателя мыши и т. Д.

Согласно книге «Чистый код», это не чистый код.

Вам не нужно ставить перед переменными-членами префикс m. Кроме того, люди быстро учатся игнорировать префикс или суффикс, чтобы увидеть значимую часть имени.

Если у вас есть проблемы вроде

ваша IDE для создания сеттеров / геттеров, и вы получите getmName () и setmName ()

Не забудьте сделать следующее (Настройки / Редактор / Стиль кода / Java / Генерация кода):

Обновление: мы не используем что-то подобное в Kotlin (поэтому лучше переключиться на него и больше не использовать префиксы)

Я думаю, что это очень индивидуально, какие условные обозначения используются в коде. Я предпочитаю называть свои переменные следующими префиксами:

• m - Переменные метода
• c - Переменные класса
• p - Переменные параметра

Но я предполагаю, что у каждого программиста свой стиль.

Чтобы доказать, что вы определенно не должны использовать это соглашение об именах переменных в своем коде, я передаю снимок экрана из родительской Android Studio ниже.

Найдите эти переменные внутри объекта, специально отсортированные, чтобы поместить m-переменные ниже, чем ваши собственные переменные. Поэтому, называя их в коде префиксом m, вы скрываете их от себя в кучу.

Единственное преимущество, которое я обнаружил в этом стиле кода, - это когда во время автозаполнения некоторой ссылки на переменную я знаю, что могу набрать «m», чтобы увидеть только переменные-члены.

С точки зрения удобочитаемости соглашение m для переменных-членов и s для статических полей больше не должно использоваться, если вы используете современную среду IDE, такую ​​как Android Studio. Android Studio может различать их, не добавляя m или s.

Как упоминалось ранее, он стилизован под другую переменную. Но также это очень полезно для генерации кода. Если вы нажмете «Alt + Insert», вы получите окна для наиболее распространенных свойств генерации кода. Если вы хотите сгенерировать метод "получить" для своей переменной, вы получите.

public class Foo{
   private int bar;

   public int getBar(){
       return this.bar;
   }

   public void setBar(int bar){
       this.bar = bar; 
   }

}

Но если вы объявите "m, s", вы получите:

public class Foo{
private int mBar;

public int getBar(){
   return mBar;
}

public void setBar(int bar){
   mBar = bar;
}
}

Он будет автоматически сгенерирован, а буквы "m" или "s" будут удалены из имени вашего конструктора, метода get, set. После этого «get» и «set» для поля будут сгенерированы без «m». Andoroid Fle-> Настройка-> Стиль кода-> Java-> Генерация кода. И сделайте как на картинке. Может, это поможет. Извините за мою англ. Настроить android

Похоже, что некоторые первые инженеры Android / Google лично предпочли начинать переменные-члены с «m», и поэтому они рекомендовали это.

Теперь это правило навязывается разработчикам в компаниях, которые не являются участниками AOSP, просто потому, что эта страница считается правилами стиля кода Android. В этом правиле мало пользы, если она вообще есть. Google следует рассмотреть возможность его удаления. В противном случае укажите, какие правила стиля кода для приложений Android являются необязательными.

Добавьте свой комментарий поддержки к этой петиции, чтобы удалить правило https://code.google.com/p/android/issues/detail?id=226814

Также можно указать, что это означает «моя», поскольку в классе / экземпляре говорится: «Эта переменная принадлежит мне, и никто другой не может до нее добраться». В отличие от static, который, хотя он может быть доступен только классу, используется всеми экземплярами этого класса. Например, если вы рисуете круги, вам нужно знать, насколько велик радиус каждого круга.

    private double mRadius;

но в то же время вы хотите, чтобы счетчик отслеживал все круги, внутри класса круга вы могли бы иметь

    private static int sCircleCount;

а затем просто используйте статические элементы, чтобы увеличивать и уменьшать количество кругов, которые у вас есть в настоящее время.

Ниже приведены соглашения об именах.

• Непубличные нестатические имена полей начинаются с m.
• Имена статических полей начинаются с s.
• Остальные поля начинаются со строчной буквы.
• Открытые статические конечные поля (константы) - ALL_CAPS_WITH_UNDERSCORES.

Пример:

public class MyClass {
    public static final int SOME_CONSTANT = 42;
    public int publicField;
    private static MyClass sSingleton;
    int mPackagePrivate;
    private int mPrivate;
    protected int mProtected;
}