Повторно используемые репозитории кода / классов
У меня есть несколько модулей, содержащих функции, классы и шаблоны, которые я храню в каталоге под названием (ха!) 'Reuse'. Я достаточно хорошо знаю контент, поэтому поиск определенного класса или фрагмента кода не займет много времени, но он медленно растет в размерах, и мне нужен какой-то разумный метод для их хранения для удобного поиска и извлечения.
Как мне это сделать?
Связанный вопрос можно найти здесь: полнотекстовый поиск исходного кода
@ bažmegakapa: согласен - я этого даже не осознавал, проголосовал за закрытие.
Ответы 8
- Группа источники по область использования (сеть, безопасность, обработка текста и т. д.); лучше всего в каталоги для облегчения просмотра.
- Ярлык функционирует путем добавления ключевые слова в исходную документацию. Используйте соответствующую систему разметки комментариев (например, javadoc) и создайте какие-нибудь индексируемые документы.
- Поиск, используя какой-то полнотекстовый поиск (grep -r, рабочий стол Google) в ваших источниках.
Я уже использую форму группировки с префиксами к именам файлов и более или менее ищу их, как вы предлагаете. Я не индексирую их (пока), но идея разметки кажется правдоподобной: своего рода гиперссылочный документ, который позволяет мне открывать / просматривать модули?
Это действительно зависит от языка, на котором вы пишете. Есть Sandcastle для C# для создания файлов CHM, javadoc для java создает кучу HTML. Такие системы документации есть в большинстве языков.
Вы можете разделить все свои классы по каталогам.
На каком языке стоит вопрос? Поскольку .Net у вас может быть библиотека, такая как DLL, разделенная пространством имен.
- Сгруппируйте функции / классы / шаблоны в модули / каталоги по функциям. Представьте, что вы будете выпускать их как библиотеки с открытым исходным кодом; подумайте, как вы хотите, чтобы был организован чужой код. В конце концов, это будет чужой код: ты, год или два назад.
- Используйте систему документации. Doxygen создаст для вас удобный браузер HTML-кода.
Обычно я группирую свои файлы в зависимости от общего назначения файлов.
Бывший: Повторное использование \ База данных Повторное использование \ Графика Повторное использование \ Math Повторное использование \ Etc ...
Затем вы можете сгруппировать свои группы
Повторное использование \ Графика \ 2D Повторное использование \ Графика \ 3D
HTH
Зависит от системы, но в тот момент, когда количество повторно используемых файлов достигает определенного порога, я стараюсь преобразовать их логические фрагменты в «настоящие» библиотеки в том же смысле, что и у сторонних разработчиков (с документацией и т. д.), И поместите их в соответствующий путь к библиотеке, чтобы их можно было использовать повторно.
Если вы не против раздать их по какой-либо лицензии OSS, вы можете даже пойти дальше и поместить их в CPAN / PyPI / PEAR-эквивалент любой среды, с которой вы работаете. Это добавляет еще больше возможностей повторного использования.
Я думаю, что важная часть по-прежнему заключается в том, что вы объединяете свой код в настоящие библиотеки. Тогда поисковая часть должна быть намного проще, поскольку в основном автоматическая.
Я уже добавляю многоразовые функции в библиотеки: дело в том, что эти модули функций / классов / шаблонов нуждаются в небольших настройках, чтобы подготовить их к использованию. Было бы сложно, из-за сложности и раздувания, обобщить для всех возможных применений.
Некоторое время назад были споры по этому поводу. Стандартное сворачивание вашего кода хорошо для читабельности и организации, но когда вы хотите просто взять что-то, есть еще один способ - каким-то образом использовать теги (например, добавляя теги к именам файлов или другим метаданным). Теги хорошо работают вместо папок, потому что вы можете быстро откопать конкретные или общие вещи, тогда как с папками вам нужно копаться в деревьях, чтобы получить конкретный материал.
Теги: O (n). Папки: O (n ^ 2)
Может быть. :П
Фолдеризация по языку (разделена на функции), с тегами, в VCS-директории, с Doxygen / Perldoc / * Pod / * - извлеченной документацией. У вас будет легко доступный архив многократно используемых модулей / документации, мгновенно переносимый в вашу рабочую среду ./
Вопрос Этот касается почти того же вопроса, и я закрою этот вопрос в его пользу.
Пожалуйста, отметьте свой вопрос как дубликат, а не добавляйте ссылку в качестве ответа.
возможный дубликат Как мне проиндексировать и сделать доступным повторно используемый код?