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

[mazzy]

Цитата:

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

А скажите - вы вот когда про префиксы говорите - вы совсем-совсем исключений не делаете?
Просто мне имена методов типа axInventTable.XYZparmNewField() очень режут глаз. Я уж скорее напишу что-то типа axInventTable.parmXYZNewField() чем префикс перед методом поставлю.

См. мое первое сообщение в этой ветке.

Цитата:

Сообщение от Ace of Database

Методы, названия которых начинающиеся с "parm" - особый случай.

ГЫ!
Если хорошенько подумать, то префиксы - зло.
(Как и обратная венгерская запись)

[mazzy]

Цитата:

Сообщение от Ace of Database

Если я не добавлю второй префикс "XYZ", то потом забуду, что это именно я добавил этот метод.

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

[Ace of Database]

mazzy, я согласен с вами
Я всегда следую правилам того ведущего разработчика, который ведет проект. В проектах, которые я веду, префикс "z"

[Vadik]

Цитата:

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

А скажите - вы вот когда про префиксы говорите - вы совсем-совсем исключений не делаете?

Если есть требования накладываемые фреймфорком (тем же AIF к примеру) - естественно делаем

Цитата:

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

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

Цитата:

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

Вижу, ветка как обычно перешла в дискусию глухого со слепым
- "нам так удобно"
- "нет, так всем ужасно неудобно, и вам тоже"

Noted. Спасибо всем высказавшимся

[Владимир Максимов]

Цитата:

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

Так как аддоны в моем случае по функциональности слабо пересекаются, я в каком-то смысле заранее представляю что я ищу

Вот в этом-то все и дело! Вся данная тема вокруг этого и построена. Именно поэтому Вы и не можете понять, о чем говорит mazzy

По Best Practices имя объекта - это идентификация модуля + идентификация функциональности

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

Однако зачастую имя аддона - это всего-лишь идентификация того, кто именно создал объект (ну, или кто "владелец" объекта). Сама по себе эта информация интереса не представляет. Именно поэтому и возникают вопросы. Совершенно лишняя информация, но без знания которой невозможно выполнить поиск объекта.

[Maxim Gorbunov]

Цитата:

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

Я такой человек - мне чтобы понять надо увидеть. Покажи что и как у тебя сгруппировано. У меня - вот так (все компактно и аккукратно). Есть и объекты с кастомизациями из обоих аддонов плюс наши, к сожалению не смог сделать скриншот который бы показал все три группы не занимая весь экран

Страшновато выглядит, честно говоря

Вот тебе хорошо, ты знаешь, какой адд-он за что отвечает. А допустим приходит новый программист без опыта работы в твоём приложении, и надо ему найти, почему поле в таблице неправильно инициализируется. По-моему, ему гораздо удобнее будет, если все initFrom будут рядом сгруппированы, чем если придётся по списку методов скакать туда обратно, чтобы их все найти, нет? А учитывая, что таких таблиц, вероятно, много...

По поводу методов, которые в разных адд-онах могут называться одинаково - извини, тоже не убедительно. Если адд-оны затрагивают одну и ту же область стандартного приложения, такие методы в любом случае будут, используешь ты префиксы или нет. Стандартные методы вроде modifiedField(), insert(), update() и т.п. ты же всё равно не сможешь переименовать. А для добавленных методов мне кажутся удобнее суффиксы - просто привычка уже есть, когда по имени метода ты понимаешь, что именно он делает, а не с какими данными. То есть, SalesLine.modifiedFIeldDDC() мне лично понятнее, чем SalesLine.ddcModifiedField().

[Maxim Gorbunov]

Цитата:

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

Если хорошенько подумать, то префиксы - зло.

Полностью поддерживаю. Для меня это главный вывод данной темы

[Link]

Цитата:

Сообщение от Maxim Gorbunov

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

Есть поиск, есть перекрестные ссылки, есть проекты. Если все в порядке, то никаких проблем все просто и удобно.

Цитата:

Сообщение от Maxim Gorbunov

По поводу методов, которые в разных адд-онах могут называться одинаково - извини, тоже не убедительно. Если адд-оны затрагивают одну и ту же область стандартного приложения, такие методы в любом случае будут, используешь ты префиксы или нет. Стандартные методы вроде modifiedField(), insert(), update() и т.п. ты же всё равно не сможешь переименовать. А для добавленных методов мне кажутся удобнее суффиксы - просто привычка уже есть, когда по имени метода ты понимаешь, что именно он делает, а не с какими данными. То есть, SalesLine.modifiedFIeldDDC() мне лично понятнее, чем SalesLine.ddcModifiedField().

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

Мой вывод данной темы, некоторые не умеют готовить преффиксы

[Maxim Gorbunov]

Цитата:

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

Есть поиск, есть перекрестные ссылки, есть проекты. Если все в порядке, то никаких проблем все просто и удобно.

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

Цитата:

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

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

Для этого есть суффикс. А в 2012 ещё и модели.

Цитата:

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

Мой вывод данной темы, некоторые не умеют готовить преффиксы

Так научите

[LeonDerCom]

Цитата:

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

В то же время сразу видно какие методы к какому решению относятся и если стоит префикс который с нашим не пересекается, то туда можно даже не заглядывать. Симпл.

Мой вывод данной темы, некоторые не умеют готовить преффиксы

То есть тоже самое по суффиксу не позволяет?
Зато когда куча аддонов и модов любителями префиксов, а таблицы с одинаковым названием - вот весело, пока вспомнишь какой префикс или его найдешь... А вот по названию таблицы, метода, класса - найти проще, потом выбирает нужную по суффиксу - все в шоколаде.

[Link]

Цитата:

Сообщение от Maxim Gorbunov

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

Не чувствую

Цитата:

Сообщение от Maxim Gorbunov

Для этого есть суффикс. А в 2012 ещё и модели.

Почему не префиксы? А ну да, потому что сортировка нарушается )

Цитата:

Сообщение от Maxim Gorbunov

Так научите

МС как раз курс делают по префиксами и суффиксам, даже сертификат отдельный будет

[Link]

Цитата:

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

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

У вас там рабочая ЕРП система или песочница?

[Владимир Максимов]

Цитата:

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

Не чувствую

Посмотрите скрин, который привел Vadik. Предположим, мне надо найти метод, который инициализирует данные. По Best Practices подобные методы называются initFromXXX.

Если префикса нет, то я встаю на первый метод класса и на клавиатуре начинаю набирать фразу "initFrom". Сразу вижу все методы, которые начинаются с этой фразы

Если префикс есть, то поиск по горячим клавишам - бесполезен. Я должен использовать Ctrl+F (это внутри методов ОДНОГО класса (!)). Никак не могу согласиться, что использование Ctrl+F (перекрестных ссылок, проектов) в данном случае - удобнее.

Цитата:

Сообщение от Link;

У вас там рабочая ЕРП система или песочница?

Со временем, любая учетная система превращается в песочницу Это грустно, но так оно и есть. Пока количество префиксов один..два с этим еще можно мириться. Но когда их общее количество переваливает за десяток, начинаются проблемы...

Вы исходите из предположения, что количество префиксов ограничено и Вы уже все их выучили. Но в общем случае оба допущения ошибочны.

[Maxim Gorbunov]

Цитата:

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

Не чувствую

Поясняю: разница в том, что использование префиксов не добавляет новых механизмов для поиска, но точно не позволяет использовать один из имевшихся старых.

На остальное отвечать, пожалуй, не буду, пока тема ещё не в курилке.

[Vadik]

Цитата:

Сообщение от Maxim Gorbunov

Страшновато выглядит, честно говоря

У меня немало времени ушло сначала на то чтобы привыкнуть, а потом - понять

Цитата:

Вот тебе хорошо, ты знаешь, какой адд-он за что отвечает. А допустим приходит новый программист без опыта работы в твоём приложении, и надо ему найти, почему поле в таблице неправильно инициализируется. По-моему, ему гораздо удобнее будет, если все initFrom будут рядом сгруппированы, чем если придётся по списку методов скакать туда обратно, чтобы их все найти, нет?

Ну, для этого как бы перекрестные ссылки напрашиваются, а сколько там аддонов, методов и суффиксов-префиксов в принципе наверное не так уж и важно, не так ли ?

Цитата:

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

Ну я наверное еще раз свою позицию проясню и отпишусь уже от ветки. Не было у меня цели кого-либо в чем-либо убеждать или агитировать, тем более - за суффиксы или префиксы. Я уже говорил - что именно вы используете, особенно при in-house разработке, неважно, если для вас это работает. Меня другое умилило - это вот принципиальное "я художник, я так вижу", "мне удобно" и слепое следование best practice ("наименование объектов и методов должно быть стандартным") со стороны не последних (как я понимаю) представителей крутых (как я понимаю) российских партнеров
Я сейчас работаю на стороне клиента и для меня необходимость минимизировать (насколько это возможно) конфликты при слиянии нескольких решений разрабатываемых независимыми группами (Microsoft, вендоры и внутренняя команда разработчиков) - не перфекционизм и не прихоть, а суровая необходимость. Наши вендоры это к счастью понимают. Как они этого добиваются - отдельная песня, и суффиксы-префиксы здесь только то что на поверхности. Я вам больше скажу - один настолько продвинут, что модифицирует только минимум стандартных методов, там где нужно в середину метода вклиниться, все остальное - на event handler-ах, что ему затратнее зато апгрейд и слияние кода для меня как пользоватеоя как правило на автомате проходит. Кто-нибудь уже делал апгрейд с 2012 RTM на R2 ? Так вот - у меня он занял один человеко-день (9 часов, а не 24 - это так, на всякий случай). По той же причине он может мне промежуточные билды моделями хоть несколько раз в неделю присылать, а я - устанавливать. Понятно что этот подход работает для тиражируемых решений (одно решение - сто клиентов и основная маржа - с продаж и от партнеров), а для самописок - нет
Вот и все

[Link]

Цитата:

Сообщение от Владимир Максимов

Посмотрите скрин, который привел Vadik. Предположим, мне надо найти метод, который инициализирует данные. По Best Practices подобные методы называются initFromXXX.

Если префикса нет, то я встаю на первый метод класса и на клавиатуре начинаю набирать фразу "initFrom". Сразу вижу все методы, которые начинаются с этой фразы

Если префикс есть, то поиск по горячим клавишам - бесполезен. Я должен использовать Ctrl+F (это внутри методов ОДНОГО класса (!)). Никак не могу согласиться, что использование Ctrl+F (перекрестных ссылок, проектов) в данном случае - удобнее.

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

Цитата:

Сообщение от Владимир Максимов

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

Вы исходите из предположения, что количество префиксов ограничено и Вы уже все их выучили. Но в общем случае оба допущения ошибочны.

Если система сильно кастомизирована и незнакома разработчику, то имхо тут как раз будет куда нагляднее видеть все объекты по префиксу. И использование поиска и перекрестных ссылок как раз самое то.

[Link]

Цитата:

Сообщение от Maxim Gorbunov

Поясняю: разница в том, что использование префиксов не добавляет новых механизмов для поиска, но точно не позволяет использовать один из имевшихся старых.

На остальное отвечать, пожалуй, не буду, пока тема ещё не в курилке.

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

Цитата:

Сообщение от Владимир Максимов

Посмотрите скрин, который привел Vadik. Предположим, мне надо найти метод, который инициализирует данные. По Best Practices подобные методы называются initFromXXX.

Если префикса нет, то я встаю на первый метод класса и на клавиатуре начинаю набирать фразу "initFrom". Сразу вижу все методы, которые начинаются с этой фразы

Да, префикс перед initFrom*, parm* и т.п. это перебор.
Но это не говорит о том, что любое применение префикса - зло.

Хотелось бы услышать в чем их зло для названий новых типов, таблиц, форм.

Допустим аддон (модуль) обозначаем Trololo.
Таблица TrololoBestTable, тогда initFrom будет выглядеть как initFromTrololoBestTable, все initFrom рядом и ссылка на модуль Trololo в наличии.

В AOT все объекты модуля Trololo рядом, все счастливы.

Может стоит изобличать лишь отдельные перегибы в использовании префиксов,
а не социалистическую систему в целом?

А вот гипотетический пример применения суффиксов:
ParametersInvent
ParametersCust
ParametersVend
ParametersSales
ParametersSmm
ParametersProd
ParametersBank
и т.д.

видите как удобно, все параметры в одном месте

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

[Ivanhoe]

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