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

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

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

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

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

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

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

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

Нужно написать програму в которой нужно определить суму двух 2D масивов - C++
В програме нужно найти суму двух двумерных массивов... буду очень признателен

Когда нужно/не нужно возвращать объект при перегрузке присваивания? - C++
Доброго времени суток! Перегрузка присваивания: class alpha { private: int data; public: alpha() // конструктор без...

Нужно ввести текст, если он больше 80 символов нужно чтоб он переходил на новую строку - C++
Написал клиент сервер, с командами add-запись в файл, remove-удаление из файла ,display-вывод на экран. Надо чтоб при вводе текста, если...

Нужно сделать задание по c++! Через 3 часа нужно сдать! - C++
ТРЕБОВАНИЯ К ВЫПОЛНЕНИЮ ЗАДАНИЙ: Требования к выполнению задания №1: 1. Требуется решить систему линейных алгебраических...

В магазине работает 5 человек, нужно составить график их работы, нужно что бы каждый день работало по 3 чел - C++
В магазине работает 5 человек, нужно что бы каждый день работало по 3 человека, но что бы через день работы каждый из этих 3 отдыхал, а на...

даны 2 последовательности в файлах, в двух разных, нужно их обьединить и отсортировать по возрастанию. Но нужно сделать прогу с помошью указателей - C++
вот текст проги которую я сделал, но без указателей. переделайте пожалуйста #include<fstream.h> #include<iostream.h> void main(){ ...

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

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

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

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

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

Добавлено через 39 секунд
Цитата Сообщение от gromo Посмотреть сообщение
Опять же, чтобы не запутаться. Если я не прав, то скажите, какими средствами пользуетесь вы чтобы превносить какой-либо порядок в систему?
он имеет ввиду, что писать не надо, а читать чужие можно ) для улучшения собственного стиля
fasked
Эксперт С++
4933 / 2513 / 180
Регистрация: 07.10.2009
Сообщений: 4,311
Записей в блоге: 1
07.09.2013, 13:33     Нужно ли документировать проект? #25
Цитата Сообщение от gromo Посмотреть сообщение
какими средствами пользуетесь вы чтобы превносить какой-либо порядок в систему?
Чаще всего это просто UML скетчи. Их хватает с головой для относительно взрослого средних размеров проекта.
Ваше желание, оно конечно похвальное, но для 2К строк кода игра не стоит свеч.
XRuZzz
Антикодер
659 / 560 / 27
Регистрация: 15.09.2012
Сообщений: 2,511
07.09.2013, 13:49     Нужно ли документировать проект? #26
открыл репозиторий на чтение, надеюсь знаете как пользоваться SVN ...
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
ЧЯДНТ?
XRuZzz
Антикодер
659 / 560 / 27
Регистрация: 15.09.2012
Сообщений: 2,511
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
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
++. сам ничего внятного сходу не нашел. спасибо
MoreAnswers
Эксперт
37091 / 29110 / 5898
Регистрация: 17.06.2006
Сообщений: 43,301
07.09.2013, 14:44     Нужно ли документировать проект?
Еще ссылки по теме:

В центре экрана нужно нарисовать квадрат. А в нем еще 8 В целом должно получиться 9 квадратов. И нужно их покрасить в 3 разные цвета - C++
помогите пожалуйста очень надо

нужно удалить и вывести все символы после *(его не нужно выводить). я смог наоборот вывести всё до него! помоите - C++
#include "stdafx.h" #include "iostream" #include "string" #include "conio.h" using namespace std; int _tmain(int argc, _TCHAR*...

нужно описать программу. т.е. каждую команду и каждую группу нужно расписать. подсобите пожалуйста - C++
#include <iostream> #include <conio.h> using namespace std; #define K_TO_M 0.6214 #define M_TO_K 1.6093 int main() { int k;...

Проект - C++
Всем привет!) Подкиньте идею какой проект можно сделать используя GTK+ и MVS2008.)) p.s. текстовые редакторы и шифрование не подходит(...

Проект на С++ - C++
Добрый день. МБ вопрос глупый. Как мне из своего проекта на Visual Studio сделать нормальное человеческое приложение? Т.е. не...


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

Или воспользуйтесь поиском по форуму:
XRuZzz
Антикодер
659 / 560 / 27
Регистрация: 15.09.2012
Сообщений: 2,511
07.09.2013, 14:44     Нужно ли документировать проект? #30
Цитата Сообщение от gromo Посмотреть сообщение
Интересно, что документ в .odt неужели фирмы не запрещают пользоваться чем-то отличным от MS поделок?
ага щазззз, я просто не распространяю наркотики...
Yandex
Объявления
07.09.2013, 14:44     Нужно ли документировать проект?
Ответ Создать тему
Опции темы

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