Соглашения об именах для методов / классов / пакетов - PullRequest
0 голосов
/ 17 ноября 2009

Какие соглашения об именах вы используете для повседневного кода? Я размышляю над этим, потому что в настоящее время у меня есть проект на Python, который содержит 3 пакета, каждый с уникальной целью. Теперь я помещаю универсальные «служебные» методы в первый пакет, который я создал для проекта, однако я собираюсь переместить эти методы в отдельный пакет. Вопрос в том, как бы я это назвал? Утилита, Коллекция, Ассорти?

Существуют ли какие-либо стандартные соглашения об именах, на которые вы клянетесь, и если да, то можете ли вы предоставить ссылки? Я знаю, что у каждого языка есть свои соглашения об именах, но есть ли какой-то конкретный, который вы считаете наиболее полезным, который вы бы порекомендовали мне начать использовать?

Ответы [ 2 ]

1 голос
/ 17 ноября 2009

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

Используя личный пример:

В Python я бы назвал пакет «utils» - или, если бы я хотел перераспределить, «coryutils» или что-то подобное, чтобы избежать коллизий пространства имен.

В Java или ActionScript я бы назвал пакет «net.petosky.utils», независимо от того, собирался я перераспределиться или нет.

0 голосов
/ 17 ноября 2009

Если у вас нет веских причин для этого, вы должны следовать указаниям, изложенным в PEP 8 . См., В частности, «Prescriptive: Naming Convention».

...