Префиксы-суффиксы. Как лучше? Стоит ли избавляться от них?

[mazzy]

Есть клиент.
Теперь с ним работаем мы. Но раньше с ним кто только не работал.

Поколения разработчиков использовали префиксы (как это рекомендовалось в ранних бест-практисах)
в результате сейчас нередки подобные названия DDD_Codes.KKK_XXX_LL_OKVED. (где ККК, ХХХ, LL - префиксы)

Поскольку кастомизированных таблиц и полей много, то сложно запомнить какие префиксы и в какой момент нужно использовать. Что выбешивает.

Вопросы:
= что лучше использовать на ваш взгляд для того, чтобы обозначить разработчика - префиксы/суффиксы/ничего?
= вы бы стали рефакторить приложение, избавляясь от префиксов (или превращая их в суффиксы)? каковы плюсы и минусы такого рефакторинга?

А также хотелось бы услышать ваше мнения и размышления по поводу префиксов/суффиксов.
Используете ли вы префиксы/суффиксы?
Когда они вам пригодились, а когда нет?

По-моему - префиксы/суффиксы совершенно бесполезная штука. Где я ошибаюсь?

Заранее спасибо.


===============
добавлено 26.10.10: итог обсуждения подвел Владимир Максимов
добавлено 26.10.10: создана тема Префиксы-суффиксы. Какой инструмент лучше использовать чтобы избавиться от префиксов?

[belugin]

Имхо префиксы нужны как неймспейсы для бедных. Чтобы не было случайных пересечений имён (кстати, хороший критерий системы именования - если создавая обхект для какой-то надобности обнаруживаешь уже созданный объект для той же самой надобности уже так же поименованный).

Количество префиксов/суффиксов должно быть равно количеству различных реестров, в которых учитываются имена. Например, если есть 10 партнерских решений, которые могут обновиться независимо, то должно быть 10 префиксов. Если код специально для данного клиента пишут последовательно 10 партнеров то должен использоваться 1 префикс, так как называя объекты не пересечешься - у последующего доработчика есть весь перечень объектов предыдущего.

Еще некоторые используют префиксы как эрзацконтрольверсий для бедных, но это из-за явной бредовости опустим. Вот таковы мои мысли.

[mazzy]

Цитата:

Сообщение от belugin

Имхо префиксы нужны как неймспейсы для бедных.

другими словами, префикс - название модуля, а не код разработчика?

Цитата:

Сообщение от belugin

Еще некоторые используют префиксы как эрзацконтрольверсий для бедных, но это из-за явной бредовости опустим. Вот таковы мои мысли.

Ок.
Стоит ли рефакторить приложение избавляясь от кодов разработчиков/компаний?
Плюсы и минусы такого рефакторинга?

[lev]

мне кажется логично использовать префикс компании (клиента) в своих костомизациях.
например если работаем в компании Vasya Pupkin то например создавая таблицу, класс, форму и все остальное, что есть в АОТ, мы будем писать: VP_Table, VP_Class, VP_Form и т.п. Это нам поможет сразу идентифицировать то, что создано в самой компании локально (по идее слои для этого, но мало ли, внедренец тоже может накодить в слое USR и т.п.)

в остальных случаях считаю, префиксы\суфиксы не нужны, а только мешают эстетическому восприятию элементов приложения

[oip]

Я на всех наших проектах по мере сил борюсь с идеей использования префиксов-суффиксов. Иногда не получается, если проект уже до моего прихода стартовал и так уже делается. Если я на проекте с самого начала, то свою точку зрения я всегда отстаивал и префексы мы не использовали. Считаю саму идею префиксов-суффиксов ужасно неудобной и мешающей в работе. Чтобы найти нужный объект, приходится делать несколько итераций поиска по АОТу (в случае префиксов). Плюс сам код выглядит более громоздким и неудобным. От одинаковых префиксов даже в глазах рябит. Ладно еще, если только таблицы-классы-формы с префиксами называют. Но когда и табличные поля (например, таблица XXX_JournalTable с полями XXX_JournalId, XXX_JournalName, XXX_JournalDate...) - это уже вообще за гранью добра и зла.

Но если в системе уже так принято, то рефакторинг я уже никогда не делал. Обычно трудозатраты на это сложно объяснить руководству и заказчику. Да и самому понятно, что скорее всего оно того не стоит.

P.S. Суффиксы на практике вообще не встречал, если честно. Если и используют, то префиксы.

[lev]

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

[sukhanchik]

Цитата:

Сообщение от mazzy

Поколения разработчиков использовали префиксы (как это рекомендовалось в ранних бест-практисах)

Ага, меня поначалу это бесило - потом привык.

Цитата:

Сообщение от mazzy

в результате сейчас нередки подобные названия DDD_Codes.KKK_XXX_LL_OKVED. (где ККК, ХХХ, LL - префиксы)

Поскольку кастомизированных таблиц и полей много, то сложно запомнить какие префиксы и в какой момент нужно использовать. Что выбешивает.

Вот именно поэтому и бесило - т.к. понимал - что в процессе жизни приложения - к этому сведется.

Цитата:

Сообщение от mazzy

Вопросы:
= что лучше использовать на ваш взгляд для того, чтобы обозначить разработчика - префиксы/суффиксы/ничего?

Вопрос: А зачем разработчика обозначать? И еще момент. Часто в качестве префикса/суффикса используют сокращенное название клиента и уж никак не внедряющую компанию/разработчика.
Сам использую сейчас суффиксы. Считаю, что нужно использовать либо ничего - либо суффиксы, т.к. в этом случае:
а) в АОТе объекты, относящиеся к одному модулю стоят рядом. И их логично находить.
б) это дисциплинирует разработчика при придумывании названия объекту - чтобы объект расположился именно среди "своих" соседей по модулю.

Если честно - то суффиксы немного мешают. Т.к. если хочется отделить штатный функционал от модификаций - то для этого есть слои и сравнение слоев. Все равно - если взять штатный метод и его полностью закомментарить - то суффикса/префикса не добавить, в то время как логика может быть изменена кардинально.
Еще один камень в огород префиксов. Допустим есть у меня объект XXX_InventJournalTable и объект YYY_InventJournalTable. При создании второго объекта - сразу можно не догадаться, что первый уже есть. А чем больше кода в системе - тем сложнее в нем разбираться. А были бы суффиксы - глядишь и второй объект и не был бы создан.

Цитата:

Сообщение от mazzy

= вы бы стали рефакторить приложение, избавляясь от префиксов (или превращая их в суффиксы)? каковы плюсы и минусы такого рефакторинга?

Нет. Точнее только ради переименования - нет. Если есть другие причины - то по мере правки - плавно переходить. Грубо говоря - сильно задел объект - изволь его переименовать и обновить ссылки на него (обновление ссылок или косметическое трогание объекта не должно вести к переименованию - тут конечно все очень субъективно- на усмотрение проверяющего код). Но опять-таки - вопрос. Ради чего? Оценит ли это клиент? А не дешевле будет обновить версию с осмысленным переносом (с переименованием) модификаций ? Глядишь - часть кода отпадет. Но опять-таки - эту черную работу никто может не оценить. Клиент также может сменить внедренца/обслуживающую его компанию. И новая компания может опять все замусорить. Хотя сначала будет сливки снимать от того, что все подчищено.

Цитата:

Сообщение от mazzy

А также хотелось бы услышать ваше мнения и размышления по поводу префиксов/суффиксов.
Используете ли вы префиксы/суффиксы?
Когда они вам пригодились, а когда нет?

Да, использую - суффксы. Да никогда не пригодились. Заставляли - вот и пришлось привыкнуть к массовости.
Хотя...один раз пригодились. Для того, чтобы лишний раз сказать клиенту - что вам впарили код с такого-то клиента

[sukhanchik]

Вдогонку. Хорошо именовать объект по тем же принципам, которые уже есть в системе.
Т.е. сначала идет префикс модуля, затем некоторое обозначение (корень слова) и окончание.
InventJournalTable
LedgerJournalTable
InventJournalTrans
CustTable
Видно - что есть "журнальные" таблицы, есть "транзакционные" и видно что к какому модулю относится.
Думаю, что суффиксы пошли от локализации - когда нужно было отличать объекты, относящиеся к разным странам

[oip]

Цитата:

Сообщение от lev

Это нам поможет сразу идентифицировать то, что создано в самой компании локально (по идее слои для этого, но мало ли, внедренец тоже может накодить в слое USR и т.п.)

Что мешает делать префикс у кода проекта? Определить, в рамках какого проекта создавался объект проблем не составляет никаких. Обычно же нет необходимости определять это "сразу", просто при взгляде на АОТ.

[lev]

Цитата:

Сообщение от oip

Что мешает делать префикс у кода проекта? Определить, в рамках какого проекта создавался объект проблем не составляет никаких. Обычно же нет необходимости определять это "сразу", просто при взгляде на АОТ.

1. когда дебажешь код сразу понятно, чье дияние
2. когда нажимаешь из формы Пр. кноп. мыши\Настройка, сразу видно кто создал и к кому вопросы

Это на вскидку, если посидеть подумать думаю ещё много вариантов найдется, когда надо посмотреть объект, не входя в проект.

[Ivanhoe]

Я против префиксов / суффиксов. В комментах можно писать все что угодно, а вот АОТ портить... Наименование объектов и методов должно быть стандартным.

[sukhanchik]

Цитата:

Сообщение от lev

1. когда дебажешь код сразу понятно, чье дияние

Ну это не повод... Код всегда можно закомментарить с указанием того, кто ваял.
А еще можно по слоям разграничиваться. Каждый ответственен за свой слой.

[oip]

Цитата:

Сообщение от lev

1. когда дебажешь код сразу понятно, чье дияние

По коду всегда должно быть сразу понятно, кто, когда и зачем его писал. У вас код не помечается меткой, в которой указан разработчик, дата, код проекта и желательно название модификации?

Цитата:

Сообщение от lev

когда нажимаешь из формы Пр. кноп. мыши\Настройка, сразу видно кто создал и к кому вопросы

Это должно быть итак понятно. Создали класс или форму - метка в КлассДекларейшн, создали таблицу - метка в файнд и екзист.

Цитата:

Сообщение от sukhanchik

Код всегда можно закомментарить с указанием того...

Нужно закомментарить.

[titov]

Префиксы\суффиксы использовать нужно, хотя бы для нормального перехода на новые версии\хот фиксы. Потому что, если при наименовании объекта программист будет размышлять так же, как поставщик MS DAX, то при переходе возникнет коллизия, особенно, если типы данных не совпадут по одинаково именованным объектам.

Между префиксом и суффиксом я бы выбрал суффиксы (_RU,_L, _W)- тогда объекты в АОТ сгруппируются по модулям\функциональности, да и при кодировании поиск в два раза меньше. Выше об этом писалось. Но на большинстве проектов заведено писать префиксы. Если заведено, то желательно продолжить в том же стиле - это уже этика. Когда корректируется код нижестоящих слоев, то правильнее делать в русле алгоритма того, кто начал уже что-то как-то писать. Иначе - переписывать.

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

[pitersky]

Я считаю, что для почти всех кастомных объектов (кроме проектов) нужен единый для компании префикс. Т.е. новаю таблицу надо называть не блаблаTable, а Х_блаблаTable. Это сразу покажет, какие именно объекты нестандартные + обезопасит от возможных перекрытий имён при переходе на новые версии продукта. Название проекта должно начинаться с префикса-идентификатора разработчика.
Суффиксы нужны только в классах-потомках и нигде более.

[sukhanchik]

Цитата:

Сообщение от titov

Префиксы\суффиксы использовать нужно, хотя бы для нормального перехода на новые версии\хот фиксы. Потому что, если при наименовании объекта программист будет размышлять так же, как поставщик MS DAX, то при переходе возникнет коллизия, особенно, если типы данных не совпадут по одинаково именованным объектам.

Теоретически - да. Собственно - для этого префиксы/суффиксы и задумывались. Но! Если логика программиста вдруг совпала с логикой от МС - то это повод задуматься об удалении /изменении собственного кода.

Пример. Если классы Bank_XX, где XX - код страны, для которой осуществляется проверка банковского счета (у каждой страны своя проверка).
Так вот. Класса Bank_RU (4.0 SP2) нет в природе. А нужен. И создавать такой класс с префиксом/суффиксом иным - просто некорректно по отношению к том, кто будет разбираться в коде. А МС однозначно обзовет такой класс именно так - если вдруг решит его выпустить.
Вывод - свой код и код от МС тут хорошо "скрестить" и этто повод делать делать не потом "генеральную уборку", а сразу не мусорить за собой.

[mazzy]

По поводу вопросов: а надо ли? будет ли остальное? как относится клиент?

Цитата:

Сообщение от sukhanchik

Нет. Точнее только ради переименования - нет. Если есть другие причины - то по мере правки - плавно переходить. Грубо говоря - сильно задел объект - изволь его переименовать и обновить ссылки на него (обновление ссылок или косметическое трогание объекта не должно вести к переименованию - тут конечно все очень субъективно- на усмотрение проверяющего код). Но опять-таки - вопрос. Ради чего? Оценит ли это клиент? А не дешевле будет обновить версию с осмысленным переносом (с переименованием) модификаций ? Глядишь - часть кода отпадет. Но опять-таки - эту черную работу никто может не оценить. Клиент также может сменить внедренца/обслуживающую его компанию. И новая компания может опять все замусорить. Хотя сначала будет сливки снимать от того, что все подчищено.

Да, рефакторинг остального - сделан и делается.
Там версия древняя, сейчас выполняется переход на ax2009. инвентаризация и чистка кода - производится. Клиент отлично понимает что это такое и чем ему грозит (есть масса внешних систем и всяких отчетностей, которые используют данные аксапты). Именно из-за вопросов совместимости и минимизации префиксы пока не трогались.

Но рано или поздно по ним нужно принять решение.
Двойное-тройное сканирование объектов АОТ тормозит как нас, так и программистов/администраторов самого клиента.
Надеюсь, что убирание префиксов повысит скорость дальнейшей работы.


Хотелось бы сосредоточиться на конкретно префиксах/суффиксах.
плюсы/минусы? стоит ли избавляться? (если все остальные вопросы решены)

[sukhanchik]

Цитата:

Сообщение от pitersky

Я считаю, что для почти всех кастомных объектов (кроме проектов) нужен единый для компании префикс.

После того как таких объектов переваливает за 5 штук - это становится неудобным (см мой пост про XXX_InventJournalTable и YYY_InventJournalTable) и ненужным (уже смотрится на модуль)

[sukhanchik]

Цитата:

Сообщение от mazzy

Надеюсь, что убирание префиксов повысит скорость дальнейшей работы.

Цена уборки может не оправдать ожидания. Либо цена будет большая, либо ожидания могут оказаться меньшими.

[mazzy]

Цитата:

Сообщение от pitersky

Я считаю, что для почти всех кастомных объектов (кроме проектов) нужен единый для компании префикс. Т.е. новаю таблицу надо называть не блаблаTable, а Х_блаблаTable.

компании клиента или компании разработчика?
а почему не суффикс?