|
0 / 0 / 0
Регистрация: 06.11.2012
Сообщений: 230
|
|
Инструменты описания структуры приложения и документирования кода?28.01.2025, 01:03. Показов 1679. Ответов 0
Метки нет (Все метки)
Заказывал у разработчика Python-скрипт, который вырос до небольшого веб-приложения.
Недавно смотрел репозиторий, сразу заметил непорядок: запутанная структура директорий, не используемые папки / файлы, какие-то дубли и т.д. Передо мной встали задачи: №1. Создать документ, где я смогу описать и увидеть проект в целом (директория / файл; назначение). №2. Навести порядок в проекте (сделать структуру, которая мне понятна; удалить не нужные папки с файлами; удалить дубли и т.д.) Для задачи №1 Пытался составить таблицу со столбцами: директория / файл; назначение. Но запутался из-за большой вложенности директорий. В итоге создал таблицу в аналоге Notion, с функцией вложенных уровней. Скрин приложил. Теперь более-менее могу понятно описать в ней структуру проекта. И дальше сам буду понимать структуру проекта (при доработках) и демонстрировать другим новым разработчикам для onboarding'га. В связи с эти возник вопрос, есть ли профессиональные решения этого вопроса? С одной стороны нужно понятное описание структуры проекта, с другой чтобы процесс не стал слишком время-затратным?
0
|
|
| 28.01.2025, 01:03 | |
|
Ответы с готовыми решениями:
0
Способы документирования кода на c# Библиотека документирования кода Где можно вкратце почитать о сложившихся правилах документирования кода? |
| 28.01.2025, 01:03 | |
|
Помогаю со студенческими работами здесь
1
Визуализация структуры БД, инструменты
Стиль описания структуры Отличительная особенность описания структуры на С++
Искать еще темы с ответами Или воспользуйтесь поиском по форуму: |
|
Новые блоги и статьи
|
|||
|
SDL3 для Web (WebAssembly): Реализация движения на Box2D v3 - трение и коллизии с повёрнутыми стенами
8Observer8 20.02.2026
Содержание блога
Box2D позволяет легко создать главного героя, который не проходит сквозь стены и перемещается с заданным трением о препятствия, которые можно располагать под углом, как верхнее. . .
|
Конвертировать закладки radiotray-ng в m3u-плейлист
damix 19.02.2026
Это можно сделать скриптом для PowerShell. Использование
. \СonvertRadiotrayToM3U. ps1 <path_to_bookmarks. json>
Рядом с файлом bookmarks. json появится файл bookmarks. m3u с результатом.
# Check if. . .
|
Семь CDC на одном интерфейсе: 5 U[S]ARTов, 1 CAN и 1 SSI
Eddy_Em 18.02.2026
Постепенно допиливаю свою "многоинтерфейсную плату". Выглядит вот так:
https:/ / www. cyberforum. ru/ blog_attachment. php?attachmentid=11617&stc=1&d=1771445347
Основана на STM32F303RBT6.
На борту пять. . .
|
Камера Toupcam IUA500KMA
Eddy_Em 12.02.2026
Т. к. у всяких "хикроботов" слишком уж мелкий пиксель, для подсмотра в ESPriF они вообще плохо годятся: уже 14 величину можно рассмотреть еле-еле лишь на экспозициях под 3 секунды (а то и больше),. . .
|
|
И ясному Солнцу
zbw 12.02.2026
И ясному Солнцу,
и светлой Луне.
В мире
покоя нет
и люди
не могут жить в тишине.
А жить им немного лет.
|
«Знание-Сила»
zbw 12.02.2026
«Знание-Сила»
«Время-Деньги»
«Деньги -Пуля»
|
SDL3 для Web (WebAssembly): Подключение Box2D v3, физика и отрисовка коллайдеров
8Observer8 12.02.2026
Содержание блога
Box2D - это библиотека для 2D физики для анимаций и игр. С её помощью можно определять были ли коллизии между конкретными объектами и вызывать обработчики событий столкновения. . . .
|
SDL3 для Web (WebAssembly): Загрузка PNG с прозрачным фоном с помощью SDL_LoadPNG (без SDL3_image)
8Observer8 11.02.2026
Содержание блога
Библиотека SDL3 содержит встроенные инструменты для базовой работы с изображениями - без использования библиотеки SDL3_image. Пошагово создадим проект для загрузки изображения. . .
|