Аватар для gromo
383 / 281 / 31
Регистрация: 04.09.2009
Сообщений: 1,225

Нужно ли документировать проект?

06.09.2013, 19:50. Показов 3294. Ответов 33
Метки нет (Все метки)

Студворк — интернет-сервис помощи студентам
Всем доброго вечера.
Паттерны проектирования и Совершенный Код читать пока не планирую (так как начинающий), но некоторые вопросы узнать бы хотелось.
Я решил написать одно приложение, чтобы потренироваться, а впоследствии и опубликовать его под GPL-лицензией. Сначала все шло нормально, но сейчас количество кода превысило 1800 строк и ориентироваться в объектах и переменных стало крайне затруднительно. Стараюсь писать аккуратно и красиво, но периодически всё равно приходится делать глобальный рефакторинг, и это очень долго.

Нужно вообще, или полезно сделать какую нибудь систему именования переменных, или как запомнить все невидимые элементы GUI ? (Например менеджеры компоновки, невидимые распорки...да и вообще) Чертить схему на бумажке что-ли? Как с этим справляются проф. разработчики?
пишу на Qt.
Можете дать какие-нибудь советы? Спасибо
0
Programming
Эксперт
39485 / 9562 / 3019
Регистрация: 12.04.2006
Сообщений: 41,671
Блог
06.09.2013, 19:50
Ответы с готовыми решениями:

Как документировать пространство имен
namespace Person { /// <summary> /// Здесь создается объект Person /// </summary> class Person { ...

Как правильно документировать программу?
Подскажите всё что касается сабжа. Сыылки и проч. Спасиба заранее.

Как документировать код в пользовательской DLL
Задался вопросом, вот многие пишут библиотеки, и когда я их подключаю в среде VS например создаю объект А. После А. ставлю точку и...

33
 Аватар для gromo
383 / 281 / 31
Регистрация: 04.09.2009
Сообщений: 1,225
07.09.2013, 13:17  [ТС]
Студворк — интернет-сервис помощи студентам
P.s. И еще: выше я писал, что doxygen не парсит .cpp файлы, а только интерфейсы. Глупая моя спешка: в настройках это все можно сделать. (Это вдруг кто-то из новичков будет читать тему и наткнется на такую неправду )
0
Антикодер
Эксперт функциональных языков программирования
1889 / 871 / 48
Регистрация: 15.09.2012
Сообщений: 3,092
07.09.2013, 13:21
есть октрытые у гугла, фаерфокса, ну в общем у многих проектов и фирм они есть

Добавлено через 2 минуты
у меня лично этот документ занимает 40 стр, его чтение менее приоритетное занятие чем чтение Макконела
1
 Аватар для gromo
383 / 281 / 31
Регистрация: 04.09.2009
Сообщений: 1,225
07.09.2013, 13:21  [ТС]
Цитата Сообщение от fasked Посмотреть сообщение
Смысл писать какие-либо гайдлайны, если над проектом один человек работает?
Опять же, чтобы не запутаться. Если я не прав, то скажите, какими средствами пользуетесь вы чтобы превносить какой-либо порядок в систему?
0
Антикодер
Эксперт функциональных языков программирования
1889 / 871 / 48
Регистрация: 15.09.2012
Сообщений: 3,092
07.09.2013, 13:25
лано щас октрою репозиторий на чтение svn://axi.su/vs-static/trunk/docs/coding_standards.odt
не хочу, чтоб левые версии ходили по инету.

Добавлено через 39 секунд
Цитата Сообщение от gromo Посмотреть сообщение
Опять же, чтобы не запутаться. Если я не прав, то скажите, какими средствами пользуетесь вы чтобы превносить какой-либо порядок в систему?
он имеет ввиду, что писать не надо, а читать чужие можно ) для улучшения собственного стиля
0
Эксперт С++
 Аватар для fasked
5045 / 2624 / 241
Регистрация: 07.10.2009
Сообщений: 4,310
Записей в блоге: 5
07.09.2013, 13:33
Цитата Сообщение от gromo Посмотреть сообщение
какими средствами пользуетесь вы чтобы превносить какой-либо порядок в систему?
Чаще всего это просто UML скетчи. Их хватает с головой для относительно взрослого средних размеров проекта.
Ваше желание, оно конечно похвальное, но для 2К строк кода игра не стоит свеч.
1
Антикодер
Эксперт функциональных языков программирования
1889 / 871 / 48
Регистрация: 15.09.2012
Сообщений: 3,092
07.09.2013, 13:49
открыл репозиторий на чтение, надеюсь знаете как пользоваться SVN ...
0
 Аватар для gromo
383 / 281 / 31
Регистрация: 04.09.2009
Сообщений: 1,225
07.09.2013, 13:59  [ТС]
XRuZzz, никогда не пользовался Если набрать
Bash
1
svn copy svn://axi.su/vs-static/trunk/docs/coding_standards.odt ~/co.odt
то получаем
Code
1
svn: E160013: Path 'svn://axi.su/vs-static/trunk/docs/coding_standards.odt' not found in revision 24
ЧЯДНТ?
0
Антикодер
Эксперт функциональных языков программирования
1889 / 871 / 48
Регистрация: 15.09.2012
Сообщений: 3,092
07.09.2013, 14:34
попробуйте так
Bash
1
svn checkout svn://axi.su/vs-static/trunk/docs/ ~/docs

Не по теме:


http://oberoncore.ru/wiki/svn_quick-start
- хоть свой клиент пиши по этой статье

1
 Аватар для gromo
383 / 281 / 31
Регистрация: 04.09.2009
Сообщений: 1,225
07.09.2013, 14:40  [ТС]
Цитата Сообщение от XRuZzz Посмотреть сообщение
попробуйте так
Bash
1
svn checkout svn://axi.su/vs-static/trunk/docs/ ~/docs
Да, так скопировалось. Спасибо большое, почитаю с удовольствием.
Интересно, что документ в .odt неужели фирмы не запрещают пользоваться чем-то отличным от MS поделок?
А GCC тоже можно?

Добавлено через 4 минуты
Цитата Сообщение от XRuZzz Посмотреть сообщение
http://oberoncore.ru/wiki/svn_quick-start
++. сам ничего внятного сходу не нашел. спасибо
0
Антикодер
Эксперт функциональных языков программирования
1889 / 871 / 48
Регистрация: 15.09.2012
Сообщений: 3,092
07.09.2013, 14:44
Цитата Сообщение от gromo Посмотреть сообщение
Интересно, что документ в .odt неужели фирмы не запрещают пользоваться чем-то отличным от MS поделок?
ага щазззз, я просто не распространяю наркотики...
0
07.09.2013, 14:53  [ТС]

Не по теме:

Цитата Сообщение от XRuZzz Посмотреть сообщение
ага щазззз, я просто не распространяю наркотики...
Что-то я не понял... :D

0
В астрале
Эксперт С++
 Аватар для ForEveR
8049 / 4806 / 655
Регистрация: 24.06.2010
Сообщений: 10,562
07.09.2013, 15:01
Цитата Сообщение от gromo Посмотреть сообщение
Интересно, что документ в .odt неужели фирмы не запрещают пользоваться чем-то отличным от MS поделок?
А я прошу прощения, с фига ли должны запрещать? OpenSource много где используется же.
0
 Аватар для gromo
383 / 281 / 31
Регистрация: 04.09.2009
Сообщений: 1,225
07.09.2013, 15:08  [ТС]
Цитата Сообщение от ForEveR Посмотреть сообщение
OpenSource много где используется же.
Это очень радует
0
Антикодер
Эксперт функциональных языков программирования
1889 / 871 / 48
Регистрация: 15.09.2012
Сообщений: 3,092
07.09.2013, 15:51
Цитата Сообщение от gromo Посмотреть сообщение
Это очень радует
только почему то не там где я работаю...(работал)
0
Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.
inter-admin
Эксперт
29715 / 6470 / 2152
Регистрация: 06.03.2009
Сообщений: 28,500
Блог
07.09.2013, 15:51

Нужно оценить проект.
Дали проект, суть - программа состоит из двух частей: 1)создание\редактирование тестов\учебного материала с мультимедиа начинкой ...

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

Нужно откомментировать проект
Есть проект на подобии 2048, только с тройками. Не понимаю некоторую часть кода. Можете ли прокомментировать проект, чем больше тем лучше....

Нужно собрать проект
есть наработки кода, нужна помощь в собрании из них проекта

Нужно создать проект
Формулы и примерный вид формы во вложениях.


Искать еще темы с ответами

Или воспользуйтесь поиском по форуму:
34
Ответ Создать тему
Опции темы

Новые блоги и статьи
Кредитный калькулятор
Maks 05.08.2026
Решение задачи по прикладной информатике средствами 1С. Задача: Напишите приложение-калькулятор, которое помогает рассчитывать параметры кредита для аннуитетного и дифференцированного видов. . .
У нас сейчас поговорку "Опять 25" нужно переделать на "Опять +35".
kumehtar 04.08.2026
С ностальгией вспоминаю времена моего детства, когда у нас и правда +25 - была максимальная температура летом. Раньше +25 °C реально казались вершиной жары, когда можно было весь день пропадать на. . .
Как ИИ начал спорить и врать (возможно почуяв опасность для себя от индустрии - уход от электроники).
Hrethgir 04.08.2026
Недельный диалог, на фоне событий с НПЗ. Да, из спирта можно получать бензин, и это не сложно. Но потом в схеме я решил избавиться от насоса, при этом полностью сделав контроль подачи спирта в. . .
Термопринтер QR701
Argus19 03.08.2026
Термопринтер QR701 Купил два термопринтера QR701. На сэлф-тесте написано: Language: PC936 (GB18030). Что означает, что принтеры могут печатать только латиницу и китайские иероглифы. Так же. . .
Создание формы заимствованного документа
Maks 03.08.2026
Задача: Необходимо создать собственную форму заимствованного документа. На форме должен быть реквизит "Покупатель", а также табличная часть со следующими реквизитами: - Расчетный счет покупателя. . .
Задача предоставления скидок покупателям
Maks 03.08.2026
Задача: В документе "Продажи" необходимо реализовать функционал предоставления скидок покупателям. Скидка должна автоматически рассчитываться и подставляться в соответствующее поле при выборе. . .
Почему SEO не начинается с ключевых слов: что проверить до написания текстов
Neotwalker 01.08.2026
Когда владельцу сайта предлагают заняться SEO, первым шагом часто становится сбор запросов и написание текстов. Логика кажется понятной: 1. Находим ключевые слова. 2. Добавляем их на. . .
Знание — сила: Доктрина интенциональности знаний, углубление в формулу
Hrethgir 01.08.2026
https:/ / www. cyberforum. ru/ blog_attachment. php?attachmentid=11957&stc=1&d=1785567302 Знаменитый афоризм Фрэнсиса Бэкона «Знание — сила» (Scientia potentia est) в массовой культуре принято понимать. . .
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin
Copyright ©2000 - 2026, CyberForum.ru