Форум программистов, компьютерный форум CyberForum.ru

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

Восстановить пароль Регистрация
 
 
Рейтинг: Рейтинг темы: голосов - 10, средняя оценка - 5.00
gromo
 Аватар для gromo
366 / 265 / 24
Регистрация: 04.09.2009
Сообщений: 1,214
06.09.2013, 19:50     Нужно ли документировать проект? #1
Всем доброго вечера.
Паттерны проектирования и Совершенный Код читать пока не планирую (так как начинающий), но некоторые вопросы узнать бы хотелось.
Я решил написать одно приложение, чтобы потренироваться, а впоследствии и опубликовать его под GPL-лицензией. Сначала все шло нормально, но сейчас количество кода превысило 1800 строк и ориентироваться в объектах и переменных стало крайне затруднительно. Стараюсь писать аккуратно и красиво, но периодически всё равно приходится делать глобальный рефакторинг, и это очень долго.

Нужно вообще, или полезно сделать какую нибудь систему именования переменных, или как запомнить все невидимые элементы GUI ? (Например менеджеры компоновки, невидимые распорки...да и вообще) Чертить схему на бумажке что-ли? Как с этим справляются проф. разработчики?
пишу на Qt.
Можете дать какие-нибудь советы? Спасибо
Similar
Эксперт
41792 / 34177 / 6122
Регистрация: 12.04.2006
Сообщений: 57,940
06.09.2013, 19:50     Нужно ли документировать проект?
Посмотрите здесь:

В центре экрана нужно нарисовать квадрат. А в нем еще 8 В целом должно получиться 9 квадратов. И нужно их покрасить в 3 разные цвета C++
C++ Нужно написать програму в которой нужно определить суму двух 2D масивов
даны 2 последовательности в файлах, в двух разных, нужно их обьединить и отсортировать по возрастанию. Но нужно сделать прогу с помошью указателей C++
C++ Нужно сделать что бы давало рандомно числа и нужно написать ответ
Нужно сделать задание по c++! Через 3 часа нужно сдать! C++
После регистрации реклама в сообщениях будет скрыта и будут доступны все возможности форума.
gromo
 Аватар для gromo
366 / 265 / 24
Регистрация: 04.09.2009
Сообщений: 1,214
07.09.2013, 13:17  [ТС]     Нужно ли документировать проект? #21
P.s. И еще: выше я писал, что doxygen не парсит .cpp файлы, а только интерфейсы. Глупая моя спешка: в настройках это все можно сделать. (Это вдруг кто-то из новичков будет читать тему и наткнется на такую неправду )
После регистрации реклама в сообщениях будет скрыта и будут доступны все возможности форума.
XRuZzz
Антикодер
577 / 478 / 23
Регистрация: 15.09.2012
Сообщений: 2,429
07.09.2013, 13:21     Нужно ли документировать проект? #22
есть октрытые у гугла, фаерфокса, ну в общем у многих проектов и фирм они есть

Добавлено через 2 минуты
у меня лично этот документ занимает 40 стр, его чтение менее приоритетное занятие чем чтение Макконела
gromo
 Аватар для gromo
366 / 265 / 24
Регистрация: 04.09.2009
Сообщений: 1,214
07.09.2013, 13:21  [ТС]     Нужно ли документировать проект? #23
Цитата Сообщение от fasked Посмотреть сообщение
Смысл писать какие-либо гайдлайны, если над проектом один человек работает?
Опять же, чтобы не запутаться. Если я не прав, то скажите, какими средствами пользуетесь вы чтобы превносить какой-либо порядок в систему?
XRuZzz
Антикодер
577 / 478 / 23
Регистрация: 15.09.2012
Сообщений: 2,429
07.09.2013, 13:25     Нужно ли документировать проект? #24
лано щас октрою репозиторий на чтение svn://axi.su/vs-static/trunk/docs/coding_standards.odt
не хочу, чтоб левые версии ходили по инету.

Добавлено через 39 секунд
Цитата Сообщение от gromo Посмотреть сообщение
Опять же, чтобы не запутаться. Если я не прав, то скажите, какими средствами пользуетесь вы чтобы превносить какой-либо порядок в систему?
он имеет ввиду, что писать не надо, а читать чужие можно ) для улучшения собственного стиля
fasked
Эксперт C++
 Аватар для fasked
4924 / 2504 / 180
Регистрация: 07.10.2009
Сообщений: 4,306
Записей в блоге: 1
07.09.2013, 13:33     Нужно ли документировать проект? #25
Цитата Сообщение от gromo Посмотреть сообщение
какими средствами пользуетесь вы чтобы превносить какой-либо порядок в систему?
Чаще всего это просто UML скетчи. Их хватает с головой для относительно взрослого средних размеров проекта.
Ваше желание, оно конечно похвальное, но для 2К строк кода игра не стоит свеч.
XRuZzz
Антикодер
577 / 478 / 23
Регистрация: 15.09.2012
Сообщений: 2,429
07.09.2013, 13:49     Нужно ли документировать проект? #26
открыл репозиторий на чтение, надеюсь знаете как пользоваться SVN ...
gromo
 Аватар для gromo
366 / 265 / 24
Регистрация: 04.09.2009
Сообщений: 1,214
07.09.2013, 13:59  [ТС]     Нужно ли документировать проект? #27
XRuZzz, никогда не пользовался Если набрать
Bash
1
svn copy svn://axi.su/vs-static/trunk/docs/coding_standards.odt ~/co.odt
то получаем
Код
svn: E160013: Path 'svn://axi.su/vs-static/trunk/docs/coding_standards.odt' not found in revision 24
ЧЯДНТ?
XRuZzz
Антикодер
577 / 478 / 23
Регистрация: 15.09.2012
Сообщений: 2,429
07.09.2013, 14:34     Нужно ли документировать проект? #28
попробуйте так
Bash
1
svn checkout svn://axi.su/vs-static/trunk/docs/ ~/docs

Не по теме:


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

gromo
 Аватар для gromo
366 / 265 / 24
Регистрация: 04.09.2009
Сообщений: 1,214
07.09.2013, 14:40  [ТС]     Нужно ли документировать проект? #29
Цитата Сообщение от 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
++. сам ничего внятного сходу не нашел. спасибо
XRuZzz
Антикодер
577 / 478 / 23
Регистрация: 15.09.2012
Сообщений: 2,429
07.09.2013, 14:44     Нужно ли документировать проект? #30
Цитата Сообщение от gromo Посмотреть сообщение
Интересно, что документ в .odt неужели фирмы не запрещают пользоваться чем-то отличным от MS поделок?
ага щазззз, я просто не распространяю наркотики...
gromo
07.09.2013, 14:53  [ТС]
  #31

Не по теме:

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

ForEveR
Модератор
Эксперт C++
 Аватар для ForEveR
7927 / 4709 / 318
Регистрация: 24.06.2010
Сообщений: 10,524
Завершенные тесты: 3
07.09.2013, 15:01     Нужно ли документировать проект? #32
Цитата Сообщение от gromo Посмотреть сообщение
Интересно, что документ в .odt неужели фирмы не запрещают пользоваться чем-то отличным от MS поделок?
А я прошу прощения, с фига ли должны запрещать? OpenSource много где используется же.
gromo
 Аватар для gromo
366 / 265 / 24
Регистрация: 04.09.2009
Сообщений: 1,214
07.09.2013, 15:08  [ТС]     Нужно ли документировать проект? #33
Цитата Сообщение от ForEveR Посмотреть сообщение
OpenSource много где используется же.
Это очень радует
MoreAnswers
Эксперт
37091 / 29110 / 5898
Регистрация: 17.06.2006
Сообщений: 43,301
07.09.2013, 15:51     Нужно ли документировать проект?
Еще ссылки по теме:

Нужно ввести текст, если он больше 80 символов нужно чтоб он переходил на новую строку C++
C++ Как скопировать проект в другой проект для дальнейшей работы над новой версией (VS)?

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

Или воспользуйтесь поиском по форуму:
XRuZzz
Антикодер
577 / 478 / 23
Регистрация: 15.09.2012
Сообщений: 2,429
07.09.2013, 15:51     Нужно ли документировать проект? #34
Цитата Сообщение от gromo Посмотреть сообщение
Это очень радует
только почему то не там где я работаю...(работал)
Yandex
Объявления
07.09.2013, 15:51     Нужно ли документировать проект?
Ответ Создать тему
Опции темы

Текущее время: 20:33. Часовой пояс GMT +3.
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin® Version 3.8.9
Copyright ©2000 - 2016, vBulletin Solutions, Inc.
Рейтинг@Mail.ru