Нотация Python?

(Почти каждый программист на Python скажет, что это делает код менее читаемым, но я привык к этому, и код, написанный без этих меток, для меня менее читаем)

FTFY.

А если серьезно, это поможет вам, но смутит и разозлит других программистов на Python, которые попытаются прочитать ваш код.

Это также не так необходимо из-за того, как работает сам Python. Например, вам никогда не понадобится форма mVariable, потому что в Python это очевидно:

class Example(object):
    def__init__(self):
        self.my_member_var = "Hello"

    def sample(self):
        print self.my_member_var

e = Example()
e.sample()
print e.my_member_var

Независимо от того, как вы обращаетесь к переменной-члену (используя self.foo или myinstance.foo), всегда ясно, что это член.

Другие случаи могут быть не столь болезненно очевидными, но если ваш код недостаточно прост, чтобы читатель мог помнить, что «переменная 'names' является параметром» при чтении функции, вы, вероятно, делаете что-то не так.

Используйте PEP-8. Он почти универсален в мире Python.

Я нарушаю PEP8 в своем коде. Я использую:

• нижний регистрCamelCase для методов и функций
• _prefixedWithUnderscoreLowercaseCamelCase для «частных» методов
• underscore_spaced для переменных (любых)
• _prefixed_with_underscore_variables для «частных» переменных (атрибутов)
• CapitalizedCamelCase для классов и модулей (хотя я перехожу к модулям в нижнем регистре)

Мне никогда не нравилась венгерская нотация. Имя переменной должно быть простым и кратким, предоставлять достаточно информации, чтобы было ясно, где (в какой области) она используется и какова ее цель, легко читаемая, связанная со значением того, на что она ссылается, а не с ее технической чепухой ( например тип).

Причина моих нарушений связана с практическими соображениями и предыдущим опытом.

• в C++ и Java традиционно используется CapitalizedCamel для классов и строчных букв Camel для функций-членов.
• Я работал над кодовой базой, в которой префикс подчеркивания использовался для обозначения частного, но не такого уж частного. Мы не хотели связываться с искажением имени Python (двойное подчеркивание). Это дало нам возможность немного нарушить формальности и посмотреть внутреннее состояние класса во время модульного тестирования.

Существует удобный скрипт соответствия pep-8, который вы можете запустить для своего кода:

http://github.com/cburroughs/pep8.py/tree/master

Это будет зависеть от проекта и целевой аудитории.

Если вы создаете приложение/плагин/библиотеку с открытым исходным кодом, придерживайтесь рекомендаций PEP.

Если это проект для вашей компании, придерживайтесь принятых в компании соглашений или чего-то подобного.

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

Я надеюсь это имеет смысл.

Вы должны просто соблюдать соглашения об именах в своем собственном коде. Однако, если вы собираетесь предоставить свой код другим разработчикам, вам следует придерживаться PEP-8.

Например, 4 пробела вместо 1 вкладки — это очень важно, когда у вас есть совместный проект. Люди, отправляющие код в исходный репозиторий с вкладками, требуют, чтобы разработчики постоянно спорили о проблемах с пробелами (что в Python является БОЛЬШОЙ проблемой).

Python и все языки имеют предпочтительные соглашения. Вы должны изучить их.

Java любит MixedCaseStuff.

C любит szHungarianNotation.

Python предпочитает stuff_with_underscores.

Вы можете писать код на Java с помощью_python_type_function_names.
Вы можете писать код на Python с помощью javaStyleMixedCaseFunctionNamesThatAreSupposedToBeReallyExplict.

до тех пор, пока ваша константа: p