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

Смысл использования префиксов/суффиксов сильно увязан с наличием и качеством документации по проекту.

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

Пример:
Название SomeTable_R012
говорит нам о том, что таблица была добавлена в рамках задания 12 проекта внедрения с кодом R (возможно это первая буква в названии консалтера).
Ищем проектную документацию этого консалтера, находим задание 12 и описание процесса, автоматизации которого способствовало выполнение данного задания.
После прочтения становится ясно с какой целью это появилось и как это использовать.

Поля в новой таблице называем без префиксов.

Затем в новом задании 128 нам вдруг понадобилось добавить поле в SomeTable_R012. Называем его SomeField_R128. Это говорит нам о том, что описание полей без суффикса искать в задании 12, а описание этого поля в задании 128.
Тоже самое проделываем, если добавляем поле в стандартную таблицу.

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

[oip]

Цитата:

Сообщение от Кирилл

Название SomeTable_R012 говорит нам о том, что таблица была добавлена в рамках задания 12 проекта внедрения с кодом R (возможно это первая буква в названии консалтера)
....
Затем в новом задании 128 нам вдруг понадобилось добавить поле в SomeTable_R012. Называем его SomeField_R128. Это говорит нам о том, что описание полей без суффикса искать в задании 12, а описание этого поля в задании 128.
Тоже самое проделываем, если добавляем поле в стандартную таблицу.

В очередной раз спрошу. Что мешает оставлять комментарии в коде с названием проекта, номером модификации, датой и id разработчика? Что мешает пользоваться системой контроля версий? Зачем уродовать приложения всякими SomeField_R128? На наших проектах никогда не встает вопрос о том, кто, когда и зачем написал какой-то код/добавил объект - это итак ясно. Хотя никаких префиксов и суффиксов мы не используем. Что мы делаем не так?

Цитата:

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

В очередной раз спрошу. Что мешает оставлять комментарии в коде с названием проекта, номером модификации, датой и id разработчика? Что мешает пользоваться системой контроля версий? Зачем уродовать приложения всякими SomeField_R128?

Ничего не мешает. Вопрос привычки.
Мифический кто-то ведет целый реестр созданных и модифицированных объектов и регулярно его обновляет.
Кто-то оставляет комментарии.
Кто-то использует суффиксы/префиксы.
Кто-то просто называет как придется и ничего не комментирует.

Кстати, все ли защитники SomeField где-нибудь в методе find удосуживаются написать комментарий, в рамках какого задания это поле было добавлено, если оно было добавлено не в том же задании, что и сама таблица?

[oip]

Цитата:

Сообщение от Кирилл

Кстати, все ли защитники SomeField где-нибудь в методе find удосуживаются написать комментарий, в рамках какого задания это поле было добавлено, если оно было добавлено не в том же задании, что и сама таблица?

Есть система контроля версий.

Цитата:

Сообщение от Кирилл

На чьих проектах?

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

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

Вот как раз хорошо документированное приложение и не требует никаких префиксов-суффиксов.

P.S. Наболело просто. Сейчас как раз частично работаю в приложении, где приняты префиксы. Ужас.

[mazzy]

Цитата:

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

Есть система контроля версий.

Угу. А вы его устанавливаете всем клиентам?
А если программисты клиента тоже работают в этом приложении и категорически отказываются? (типа, сложно...)

(впрочем, это оффтопик)

Цитата:

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

P.S. Наболело просто. Сейчас как раз частично работаю в приложении, где приняты префиксы. Ужас.

Цитата:

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

На наших проектах ...

На чьих проектах?

Цитата:

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

Что мы делаем не так?

Все хорошо, все так. Каждый выбирает удобный ему способ. Можно почесать макушку рукой, можно специальным скребком, можно нанять команду чесателей. Это не означает, что какой-то из этих способов неверен.

[mazzy]

Цитата:

Сообщение от Кирилл

Пример:
Название SomeTable_R012
говорит нам о том, что таблица была добавлена в рамках задания 12 проекта внедрения с кодом R (возможно это первая буква в названии консалтера).

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

с суффиксом получится
SomeTable_R012_D0045_C05

с префиксом получится
C05_D0045_R012_SomeTable

Цитата:

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

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

с суффиксом получится
SomeTable_R012_D0045_C05

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

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

[mazzy]

Цитата:

Сообщение от Кирилл

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

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

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

Если же все последующие проекты записывать каким-то образом в первоначальный проект. Но снова возникает вопрос неактуальности. Расхождений кода и документации и т.п.
И снова разработчик должен сканировать код.

Цитата:

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

предположим, он даже доступен текущему поколению разработчиков.

Да

Цитата:

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

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

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

Поля SomeTable_R12, которые не имеют суффиксов описаны в R12, поле SomeField_R128 из таблицы SomeTable_R12 описано в R128.

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