Соглашения об интерфейсе имени, когда имя уже начинается с заглавной буквы - PullRequest
0 голосов
/ 04 июня 2010

Допустим, я хочу создать интерфейс для класса с именем JQuery.

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

Что ты думаешь?

Ответы [ 3 ]

1 голос
/ 04 июня 2010

Я никогда не был большим поклонником встраивания информации о типе объекта в его имя, поэтому я бы не стал использовать I в качестве префикса в любом случае. Но если вы делаете, это хорошая идея придерживаться соглашения, но на основе вашего примера я бы также рассмотрел, как вы называете свои интерфейсы, потому что из того, что я могу сказать, вы бы получили IJQuery и JQueryImpl.

Я бы назвал ваш интерфейс чем-то вроде JavaScriptLibrary, а затем назвал бы ваш реализующий класс JQuery или Prototype.

В Java:

public interface JavaScriptLibrary { ... }

public class JQuery implements JavaScriptLibrary { ... }

public class Prototype implements JavaScriptLibrary { ... }
0 голосов
/ 04 июня 2010

У Ponzao есть хорошая точка зрения, и я склонен не встраивать информацию о типах в имена классов, переменных и т. Д. Однако, работая с несколькими файлами, я считаю, что маркировка интерфейсов полезна.

Я использую два соглашения об именах, которые были очень полезны в прошлом:

1) m_variableName

m_ выделяется в коде, отмечая переменные-члены.

2) IThisIsAnInterface

Для интерфейсов вы можете рассмотреть что-то вроде I_JQuery с I_ , отмечающим ваш интерфейс.

-bn

0 голосов
/ 04 июня 2010

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

...