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

С++ для начинающих

Войти
Регистрация
Восстановить пароль
 
 
Рейтинг: Рейтинг темы: голосов - 10, средняя оценка - 5.00
gromo
370 / 269 / 24
Регистрация: 04.09.2009
Сообщений: 1,214
#1

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

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

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

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

Нужно добавить проект на гугл-диск, как сделать так, чтобы запускалась сразу консоль, одним файлом? - C++
Нужно добавить проект на гугл-диск, как сделать так, чтобы запускалась сразу консоль, одним файлом?

Как скопировать проект в другой проект для дальнейшей работы над новой версией (VS)? - C++
(Visual Studio 2013) Например я сделал один проект, пусть это будет проект версия №1, затем я захотел улучшить проект версии №1 и сделать...

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

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

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

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

Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.
gromo
370 / 269 / 24
Регистрация: 04.09.2009
Сообщений: 1,214
07.09.2013, 12:24  [ТС] #16
Цитата Сообщение от OhMyGodSoLong Посмотреть сообщение
Ну, лол, вместо документации Ogre подставляете свою и... вуаля. (Писать её, правда, придётся самостоятельно. Неудобно, да )
Ну почитать ее я и в браузере могу, интеграция в IDE не нужна. Вот только смущает то, что на windows версии qt Creator есть динамическая справка по классам Qt, а в linux версии нету. СТраноо
0
XRuZzz
Антикодер
676 / 577 / 28
Регистрация: 15.09.2012
Сообщений: 2,523
07.09.2013, 12:36 #17
Цитата Сообщение от gromo Посмотреть сообщение
Ну вообще-то сам придумал Подумал, что когда переменных доходит до 1 000 000 то какой-то общий шаблон учета должен бы существовать. Ну раз нет...
собственно Макконел как раз об этом и пишет в книге "Совершенный Код".

Есть такое чудо как венгерская нотация. По началу я использовал элементы венгерской нотации, но со временем осознал бесполезность суффиксов и префиксов. От этого у меня осталось тока приставка "p" для указателей.

названия переменных и объектов просто должны быть осмысленными и не включать в себя неодназначные сокращения.

походу тут речь идёт о документе, который описывает стиль программирования, у меня есть свой такой документ. Если будет не лень то скину вам его.
1
gromo
370 / 269 / 24
Регистрация: 04.09.2009
Сообщений: 1,214
07.09.2013, 13:12  [ТС] #18
Цитата Сообщение от XRuZzz Посмотреть сообщение
собственно Макконел как раз об этом и пишет в книге "Совершенный Код".
Правда? Не знал, серьезно.
Цитата Сообщение от XRuZzz Посмотреть сообщение
Есть такое чудо как венгерская нотация
Не знал, что это так называется но тоже использую часто.
Цитата Сообщение от XRuZzz Посмотреть сообщение
походу тут речь идёт о документе, который описывает стиль программирования, у меня есть свой такой документ. Если будет не лень то скину вам его.
Да да да! Речь о таком документе (не знал просто как он называется). Скиньте, пожалуйста, по возможности.
Такие документы вообще пишут в энтерпрайзе (как они тогда там называются?) ? Или это для личных проектов, для удобства?
0
XRuZzz
Антикодер
676 / 577 / 28
Регистрация: 15.09.2012
Сообщений: 2,523
07.09.2013, 13:16 #19
Цитата Сообщение от gromo Посмотреть сообщение
Да да да! Речь о таком документе (не знал просто как он называется). Скиньте, пожалуйста, по возможности.
Такие документы вообще пишут в энтерпрайзе (как они тогда там называются?) ? Или это для личных проектов, для удобства?
лично я писал в фирме, согласовывая с более опытным товарищем
0
fasked
Эксперт С++
4936 / 2516 / 180
Регистрация: 07.10.2009
Сообщений: 4,311
Записей в блоге: 1
07.09.2013, 13:16 #20
Цитата Сообщение от gromo Посмотреть сообщение
Или это для личных проектов, для удобства?
Смысл писать какие-либо гайдлайны, если над проектом один человек работает?
0
gromo
370 / 269 / 24
Регистрация: 04.09.2009
Сообщений: 1,214
07.09.2013, 13:17  [ТС] #21
P.s. И еще: выше я писал, что doxygen не парсит .cpp файлы, а только интерфейсы. Глупая моя спешка: в настройках это все можно сделать. (Это вдруг кто-то из новичков будет читать тему и наткнется на такую неправду )
0
XRuZzz
Антикодер
676 / 577 / 28
Регистрация: 15.09.2012
Сообщений: 2,523
07.09.2013, 13:21 #22
есть октрытые у гугла, фаерфокса, ну в общем у многих проектов и фирм они есть

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

Добавлено через 39 секунд
Цитата Сообщение от gromo Посмотреть сообщение
Опять же, чтобы не запутаться. Если я не прав, то скажите, какими средствами пользуетесь вы чтобы превносить какой-либо порядок в систему?
он имеет ввиду, что писать не надо, а читать чужие можно ) для улучшения собственного стиля
0
fasked
Эксперт С++
4936 / 2516 / 180
Регистрация: 07.10.2009
Сообщений: 4,311
Записей в блоге: 1
07.09.2013, 13:33 #25
Цитата Сообщение от gromo Посмотреть сообщение
какими средствами пользуетесь вы чтобы превносить какой-либо порядок в систему?
Чаще всего это просто UML скетчи. Их хватает с головой для относительно взрослого средних размеров проекта.
Ваше желание, оно конечно похвальное, но для 2К строк кода игра не стоит свеч.
1
XRuZzz
Антикодер
676 / 577 / 28
Регистрация: 15.09.2012
Сообщений: 2,523
07.09.2013, 13:49 #26
открыл репозиторий на чтение, надеюсь знаете как пользоваться SVN ...
0
gromo
370 / 269 / 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
ЧЯДНТ?
0
XRuZzz
Антикодер
676 / 577 / 28
Регистрация: 15.09.2012
Сообщений: 2,523
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
- хоть свой клиент пиши по этой статье

1
gromo
370 / 269 / 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
++. сам ничего внятного сходу не нашел. спасибо
0
XRuZzz
Антикодер
676 / 577 / 28
Регистрация: 15.09.2012
Сообщений: 2,523
07.09.2013, 14:44 #30
Цитата Сообщение от gromo Посмотреть сообщение
Интересно, что документ в .odt неужели фирмы не запрещают пользоваться чем-то отличным от MS поделок?
ага щазззз, я просто не распространяю наркотики...
0
MoreAnswers
Эксперт
37091 / 29110 / 5898
Регистрация: 17.06.2006
Сообщений: 43,301
07.09.2013, 14:44
Привет! Вот еще темы с ответами:

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

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

нужно доработать проект пятнашки( - Delphi
есть косяк с кнопкой назад когда заходиш в справку...и не могу вместо кнопок поставить картинки которые намутил(как можно сюда проект...

Нужно открыть проект на руби - Ruby on Rails
Нужно открыть проект на руби, пишет следующую ошибку при открытии(rails s) run bundle install to install missing gems Пошаманил со...


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

Или воспользуйтесь поиском по форуму:
Yandex
Объявления
07.09.2013, 14:44
Ответ Создать тему
Опции темы

КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin® Version 3.8.9
Copyright ©2000 - 2017, vBulletin Solutions, Inc.
Рейтинг@Mail.ru