Как и где сохранять код проектов?

Question

[Александр Маджугин]

Работаю с большим количеством проектов. Часто выполняют точечные и нетривиальные доработки. Хотелось бы сохранять код проектов в каком-то одном месте для поиска по нему чтобы не перепридумывать одни и те же вещи. Сохранять и оформлять все в снипеты лень.

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

Answer 1

[Василий Банников]

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

Comments

[Александр Маджугин]

Оформление в библиотеку (модуль/пакет) в несколько раз увеличит затраты на реализацию. Заказчикам это не понравится. А большинство вещей вообще не будут никогда использованы повторно. Я так вижу что возвращаюсь только к 20% кода. Т.е. затраты еще раз будут умножены на 5.

Часто это куски которые в принципе глупо выделять в библиотеку. Буквально снипеты в 5-10-20 строк.

Хочется иметь механизм поиска по всему написанному мной коду.

А потом скормить его GPT6 и пусть он за меня работает.

[Василий Банников]

Александр Маджугин,

Оформление в библиотеку (модуль/пакет) в несколько раз увеличит затраты на реализацию

Так это не проблема заказчика, а твоя. Вынеся 1 раз то что может использоваться повторно - ты будешь экономить время десятикратно.

А большинство вещей вообще не будут никогда использованы повторно. Я так вижу что возвращаюсь только к 20% кода. Т.е. затраты еще раз будут умножены на 5.

Ну так и выделяй только то что использовалось повторно хотябы 1 раз.

Часто это куски которые в принципе глупо выделять в библиотеку. Буквально снипеты в 5-10-20 строк.

Зависит от того что они делают. Иногда можно отрефакторить и вынести кусок побольше, а некоторые можно сгруппировать.

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

Хочется иметь механизм поиска по всему написанному мной коду.

Подними свой гитлаб и ищи в нём сколько влезет)
Или заметки веди какие.

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

[Александр Маджугин]

Ну так и выделяй только то что использовалось повторно хотябы 1 раз.

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

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

Да ладно? Серьезно что ли? Ты не пользуешься снипетами в редакторе?

Ну вот например - создание копии пункта корзины:

$QuantityNewItem = $item->getQuantity() - $Quantity;
            $newItem = $basket->createItem('catalog', $item->getField('PRODUCT_ID')); //создаём новый товар в корзине
            $newItem->setFields(array(
                    'QUANTITY' => $QuantityNewItem,
                    'CURRENCY' => $item->getField('CURRENCY'),
                    'LID' => $item->getField('LID'),
                    'PRODUCT_PROVIDER_CLASS' => $item->getField('PRODUCT_PROVIDER_CLASS')
                ));

            // перенос свойств
            $propCollectionNewItem = $newItem->getPropertyCollection();
            $refPropsNewItem = self::extractProps($item);
            $propCollectionNewItem->setProperty($refPropsNewItem);
            // конец переноса свойств

            $item->setField('QUANTITY',$Quantity);

Хрен его знает - потребуется ли это когда-нибудь?

[Александр Маджугин]

Решил добавлять в классы что-то типа тегов:

[Василий Банников]

Александр Маджугин,

Да ладно? Серьезно что ли? Ты не пользуешься снипетами в редакторе?

Сниппетами - да. А вот логику в сниппеты я не пихаю.

Всякие скидки и акции - пахнут скорее вынесением логики в модуль.

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

Так откуда же я знаю что может потребоваться повторно?

Логически. Откуда-то же все другие, кроме тебя, это знают?

[Василий Банников]

Александр Маджугин, копирование объекта вообще не нужно писать много раз - один раз написал функцию и одной строкой применяешь там, где это нужно..

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

Сейчас с телефона, так что пример дать не смогу.

[Adamos]

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

[Александр Маджугин]

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

[Александр Маджугин]

Adamos, вероятнее всего конкретно это, как минимум в таком виде, не понадобиться никогда.

[Александр Маджугин]

Василий Банников, и как мне логика поможет определить - потребуется ли кому-то из будущих заказчиков подобный функционал?

[Василий Банников]

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

[Василий Банников]

Александр Маджугин,

а в функцию выносить смысла особого нет.

Раз возникает желание скопировать - значит есть.

Именно потому что приходится делать таким большим количеством кода

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

[Александр Маджугин]

Василий Банников, может я как-то не понятно пишу.. хз.

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

Вряд ли кому-то когда-то потребуется именно такая скидка - нет смысла ее выносить в отдельный модуль, тем более что модуль это сразу +несколько часов.
Снипеты вынесены в снипеты и тоже залиты и на гитхаб и на marketplace.visualstudio.com

Речь не о них. Речь именно об истории кода всех проектов. О том, что не оформлено в библиотеку или модуль, и не подходит под понятие снипета.

[Василий Банников]

Александр Маджугин,

Вряд ли кому-то когда-то потребуется именно такая скидка

1+1=3 - Это очень популярный формат скидок. По факту это вообще скидка 33.3% при покупке трёх предметов.
Если порефакторить и обобщить, вполне можно сделать фреймворк для описания вообще любых форматов скидок, и тогда можно будет вообще добавление новой скидки на пользователя системы повесить, чтобы он сам декларативно их и добавлял.

Answer 2

[Сергей delphinpro]

Локальная база знаний:

• Десктопные решения, типа OneNote или Joplin
  
• Локальный сайт с кастомным решением под себя или просто с wiki движком
  
• Гисты на гитхабе или аналоги
  
• Да хоть тупо файлики в отдельной директории на компе
  

Выбирайте то, что вам удобнее или проще

Answer 3

[CityCat4]

Уже много-много лет храню все наработки в одной репе, разнося по каталогам. Репа - в одной точке хранения, подключается по мере необходимости.
и да, тут согласен с Василий Банников - все, что можно использовать повторно - оформляй библиотеками. Небольшая затрата на оформление компенсируется в дальнейшем простотой использования - как оно работает внутри со временем забудется, а работать будет :)

Comments

[Александр Маджугин]

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

Answer 4

[Юрий]

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

Answer 5

[Артур К.]

мне это напоминает один мем:


Есть "база", которую прошли миллионы разработчиков. Об этом же пишут в комментах ниже.

Проект - репа
Повторный код, если можно выделить в отдельную библиотеку/набор/блок - тоже в репу.
Если это мелкая вставка - в сниппет в IDE.

А если что-то "не удобно", то возможно вы неправильно это "готовите" =)

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

*Всех благ..

Comments

[Александр Маджугин]

Повторный код, если можно выделить в отдельную библиотеку/набор/блок - тоже в репу.
Если это мелкая вставка - в сниппет в IDE.

Серьёзно? Вы на полном серьезе сейчас сказали что ВЕСЬ код ВСЕХ ваших проектов, либо выделен в модули, либо добавлен в сниппеты IDE?
Простите, но я не верю.