Yarn: Префиксы и суффиксы в именовании классов

из личного обсуждения с @asiekierka на днях:

22:34 <kasheek> I have a 'block' package with:
22:34 <kasheek> 'BedBlock'
22:34 <kasheek> 'CactusBlock'
22:34 <kasheek> 'MagmaBlock'
22:34 <kasheek> and I import them all into one of my classes. I can:
22:34 <kasheek> - look at the imports, in alphabetical order, without reading "Block" before each word
22:34 <kasheek> - search for ".BedBlock" and get results for BedBlock *and* BedBlockEntity *and* BedBlockEntityRenderer
22:34 <asie> that last one
22:34 <asie> that's a good argument

Я бы сказал, что поиск в большинстве современных Java IDE будет достаточно нечетким, чтобы результат отображался независимо от порядка BlockBed / BedBlock.

Думаю, Mojang использует либо суффиксы (BedBlock), либо просто имена (Bed).

[отрывок!]

Эти классы, вероятно, находятся в одном пакете и называются так:

RenderType
RepeaterBlock
RotatedPillarBlock
Rotation
SandBlock

Другой пример, который также показывает, что имена Mojang не имеют префиксов I для интерфейсов:

[отрывок!]

Первый имеет преимущества при сортировке имен в редакторе.

Это верно, если все отображается в один большой пакет «приемник» (например, net.minecraft.src ), но это плохая замена для правильного отображения пакетов. И если классы помещаются в пакеты, такие как blocks , items , entities , префиксы становятся избыточными.

Хотя ваши усилия достойны похвалы, пожалуйста, не размещайте здесь материалы MCP. Пожалуйста, используйте сопоставления Enigma или Tiny mappings из pomf, чтобы продемонстрировать свою точку зрения в следующий раз, или намекните на нее, не публикуя имена напрямую.

Тем не менее, исследование приветствуется! Мы уже знали, что Mojang не использует префиксы I, благодаря Brigadier, но другой намек довольно интересен. В какой-то момент я планировал посмотреть на алфавитный порядок, однако также не нужно предполагать, что «внутренние имена» Minecraft идеальны или подходят для более модифицированной среды разработки.

Мне лично нравятся префиксы, потому что это означает, что все элементы группируются вместе, все биомы группируются вместе и т. Д. Конечно, контраргумент состоит в том, что суффиксы объединяют все, что имеет что-то общее, вместе, например IronIngot, IronSword, IronBlock, IronChestplate и т. Д.

@Boundarybreaker На самом деле, они все равно находятся в пакетах. Итак, в .block вещи уже сгруппированы. Неважно, это BlockBed и BlockChest или BedBlock и ChestBlock.

О да. Это хороший момент. Я больше думал со стороны разработчиков модов. Тогда меня устраивают суффиксы.

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

Я считаю, что он работает лучше при поиске типа объекта в моей среде IDE, и, честно говоря, мне он кажется лучше.

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

Я думаю, что все моды используют префикс, потому что они используют имена MCP, а имена MCP в основном используют префикс, потому что давным-давно весь minecraft был деобфусцирован в один пакет net.minecraft.src . Однако, особенно в новом коде, есть много примеров с суффиксами. Например, ILightEngine , ChunkTask , SurfaceBuilder , IWorldCarver , IChunkGenSettings реализации, классы Config / Pieces / Structure для структур. В коде рецептов и генерации добычи есть много производных классов, которые не включают имя базового класса.

✓ РАССМАТРИВАЙТЕ окончание имени производных классов именем базового класса.

Это очень удобно для чтения и ясно объясняет отношения. Вот некоторые примеры этого в коде: ArgumentOutOfRangeException, который является разновидностью исключения, и SerializableAttribute, который является разновидностью атрибута. Однако при применении этого правила важно руководствоваться разумным суждением; например, класс Button является своего рода событием Control, хотя Control не фигурирует в его имени.

Из Руководства по дизайну C #

Я думаю, что использование префиксов блокирует вас в этой схеме и не допускает никаких «суждений». Но, возможно, это действительно не нужно для широких иерархий наследования, таких как Block или Item

Я просто подумал, посмотрите на реализации JEI. В api нет префиксов префиксов, поэтому все классы поддержки JEI сообщества моддинга - это Machine + Category / Wrapper / и т. Д.

У MCP не было суффикса move из-за большой зависимости от существующих модов. С тканью дело обстоит иначе.

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

Я только что подумал: префиксы! = Обратное написание, также они бывают разных вкусов

Примеры из MCP: [snip!]

Думаю, вы согласитесь, что непоследовательность в именовании - это плохо, такие имена, как [snip!], Ужасны.

Я, наверное, слишком поздно с этим ...

Пожалуйста, прекратите публиковать примеры MCP на каналах связи pomf, иначе я буду вынужден заблокировать вас в репозитории GitHub.

https://github.com/FabricMC/pomf/tree/18w47b