|
|
Регистрация Восстановить пароль |
Повторная активизация e-mail |
Регистрация | Задать вопрос |
Заплачу за решение |
Новые сообщения |
Сообщения за день |
Расширенный поиск |
Правила |
Всё прочитано |
|
|
Опции темы | Поиск в этой теме |
27.10.2009, 07:51 | #11 | |
Форумчанин
Регистрация: 25.09.2008
Сообщений: 209
|
Цитата:
главный вопрос, как потом искать то, что "нужно доделать". Иногда модуль не на одну тысячу строк размером. |
|
27.10.2009, 08:34 | #12 |
ios developer
Старожил
Регистрация: 16.11.2007
Сообщений: 2,885
|
2alexinspir Совершенно верно, нечего велосипеды изобретать. Есть вполне общепринятые ASDoc, Jdoc... ну и их аналоги под конкретные языки.
Делайте что хотите, но чтобы через полчаса в лесу было светло, сухо и медведь!
|
27.10.2009, 08:48 | #13 |
Форумчанин
Регистрация: 09.09.2009
Сообщений: 181
|
Меня интересует ваше мнение по поводу того,как прозывать модуль?
Код:
Например: Сокращ. название организации,дальше идет отдел и потом уже название самого непосредственно модуля. Так советую во многой документации. Но я считаю, например, что название отдела (хоть и сокращенное) не должно быть. Оно указывается ниже. Непосредственное название модуля также повторяется дважды: в Код:
Код:
Этот Код:
Получил помощь — отблагодарил.
|
27.10.2009, 08:51 | #14 |
ios developer
Старожил
Регистрация: 16.11.2007
Сообщений: 2,885
|
Название должно соответствовать задачам модуля. И точка.
Делайте что хотите, но чтобы через полчаса в лесу было светло, сухо и медведь!
|
27.10.2009, 10:05 | #15 | |
Белик Виталий :)
Старожил
Регистрация: 23.07.2007
Сообщений: 57,097
|
Цитата:
I'm learning to live...
|
|
27.10.2009, 10:23 | #16 | |
Форумчанин
Регистрация: 09.09.2009
Сообщений: 181
|
Цитата:
Хотелось бы разработать единственный и правильный экземпляр заголовка модуля. Это нужно когда берешь код твоего бывшего коллеги и в ближайшее время нужно переделать. Но не можешь понять —это действительно тот код или всего лишь часть, да и вообще—это его ли. А ещё в папке с программой лежат, например, непонятные модули. Может он ими временно пользовался или думал пользоваться или просто случайно скопировал. А так можно было бы посмотреть в заглавный и последующие модули и четко понять—что и как использовать. Но чтобы это было не просто набросано, а читабельно разложено по полочкам. Если большие программы это очень хорошо помогает. Друзья, я так и не пойму, что никто не использует определенных (даже своих) стандартов в своей организации. Что всё пишется по старинке —"потом разберусь..."? Я так не думаю...
Получил помощь — отблагодарил.
|
|
27.10.2009, 10:27 | #17 |
ios developer
Старожил
Регистрация: 16.11.2007
Сообщений: 2,885
|
Еще раз: http://jsdoc.sourceforge.net/ Чем не устраивает? Мало того, она еще и доки генерит по нему. Спецификации по-моему сейчас для практически всех языков есть.
Делайте что хотите, но чтобы через полчаса в лесу было светло, сухо и медведь!
|
27.10.2009, 11:21 | #18 | |
Форумчанин
Регистрация: 09.09.2009
Сообщений: 181
|
Цитата:
Но я даже ставить передумал, когда увидел примеры. Вот, например: Код:
2. Да и вообще—кому нужен такой комент! Название функции само говорит за себя. Можно написать: PHP код:
Вот над этим, ребята, как раз и надо работать. Не нужно пользоваться готовыми, но не точными шаблонами. Нужно сделать свое и правильное. Мы же не роботы: "скопировал-вставил" и забыл. Компилятор та поймет если мы всю программу напишем в одну строчку. А мы? Может на это вопрос дизайнеры чего подкинут...
Получил помощь — отблагодарил.
|
|
27.10.2009, 11:28 | #19 |
ios developer
Старожил
Регистрация: 16.11.2007
Сообщений: 2,885
|
Это называется самодокументируемый код. Спасает от огроммного геморроя при поддержке и модификации. Ставить ничего не обязательно, и да, ты прав! К черту международные стандарты, будем лепить как хотим, нам никто не указ. Только не надо потом удивляться почему 1с бредприятие работает так, словно его гастробайтеры писали.
Зы. Коммент этот, уважаемый, нужен к примеру тогда когда я отладочным браузером щупаю функцию в каком-нибудь скрипте, то я на экране у себя вижу что ей нужны за параметры (браузер понимает эти вещи) и чего она мне вертает. И к чему обращается. И что в комментах. Так же как эти теги работают во время обращения к функции класса из другого модуля. IDE их подхватывает и показывает всплывающие подсказки как в библиотечных классах. Надо было не выхватывать из контекста, а хотя бы напрячься и почитать, там все описано.
Делайте что хотите, но чтобы через полчаса в лесу было светло, сухо и медведь!
Последний раз редактировалось crazy horse; 27.10.2009 в 11:33. |
27.10.2009, 11:37 | #20 | |
Форумчанин
Регистрация: 09.09.2009
Сообщений: 181
|
Цитата:
PHP код:
Для чего он такой вообще нужен?
Получил помощь — отблагодарил.
|
|
|
Похожие темы | ||||
Тема | Автор | Раздел | Ответов | Последнее сообщение |
Поиск пути, ...как подключить модуль? | Лубышев | Gamedev - cоздание игр: Unity, OpenGL, DirectX | 1 | 25.09.2009 15:49 |
Как подключить модуль??? | diliana | Общие вопросы Delphi | 3 | 29.05.2009 19:14 |
Как удалить модуль и userform | komar73 | Microsoft Office Excel | 2 | 26.03.2009 15:37 |
Как перекомпилить модуль | UnD)eaD)Snake | Общие вопросы Delphi | 3 | 10.09.2007 13:35 |
Как взять модуль числа | bondar | Assembler - Ассемблер (FASM, MASM, WASM, NASM, GoASM, Gas, RosAsm, HLA) и не рекомендуем TASM | 4 | 11.05.2007 20:09 |