Warning: Cannot use a scalar value as an array in /home/admin/public_html/forum/include/fm.class.php on line 757

Warning: Invalid argument supplied for foreach() in /home/admin/public_html/forum/include/fm.class.php on line 770
Форумы портала PHP.SU :: Версия для печати :: коментарии в длинном коде
Форумы портала PHP.SU » » Объектно-ориентированное программирование » коментарии в длинном коде

Страниц (2): [1] 2 »
 

1. White - 27 Июня, 2011 - 14:02:34 - перейти к сообщению
Имеется скрипт представляющий собой библиотеку API функций и классов, размером чуть более 1000 строк. Условно его возможно поделить на блоки, согласно задач выполняемых функциями. В процессе разработки каждый блок вынесен в отдельный файл для простоты поиска, после все собирается в отдельный файл.Скрипт имеет открытый исходный код, поэтому хочется сделать его наиболее читаемым.
Теперь суть вопроса: Как наиболее красиво условно разделить файл на блоки с помощью комментариев, чтобы его было удобнее всего читать (не только мне)
2. Bertolomych - 27 Июня, 2011 - 14:38:03 - перейти к сообщению
Мне больше всего нравится вариант:
CODE (htmlphp):
скопировать код в буфер обмена
  1.  
  2. /******************************************
  3.  *           Новый блок                   *
  4.  ******************************************
  5.  * В этом блоке делается то-то и то-то    *
  6.  * Функции:                               *
  7.  * someFunc() - делает то-то              *
  8.  ******************************************/
  9.  

Если речь об этом =)
3. White - 27 Июня, 2011 - 14:49:38 - перейти к сообщению
Цитата:
Если речь об этом =)

Речь именно об этом. Подмигивание

Еще варианты? Хочется услышать больше мнений.
4. Ejas Tower - 21 Июля, 2011 - 11:18:55 - перейти к сообщению
Bertolomych пишет:
Мне больше всего нравится вариант:
CODE (htmlphp):
скопировать код в буфер обмена
  1.  
  2. /******************************************
  3.  *           Новый блок                   *
  4.  ******************************************
  5.  * В этом блоке делается то-то и то-то    *
  6.  * Функции:                               *
  7.  * someFunc() - делает то-то              *
  8.  ******************************************/
  9.  

Если речь об этом =)

А может сделать то же самое, но в виде таблицы?
5. Мелкий - 21 Июля, 2011 - 11:27:45 - перейти к сообщению
Мне нравится стиль JavaDoc. Логичен, распространён и можно документацию собирать автоматом.
6. DeepVarvar - 21 Июля, 2011 - 11:28:01 - перейти к сообщению
Ejas Tower пишет:
в виде таблицы
Какой таблицы и где?
7. Champion - 21 Июля, 2011 - 12:17:58 - перейти к сообщению
Если вы хотите что-то разделить на логически отделенные блоки, то это стоит делать не комментариями, а собиранием кода в функции, классы, отдельные файлы. Вот.
8. White - 21 Июля, 2011 - 20:11:17 - перейти к сообщению
Champion речь как раз о том что если все функции и классы собраны в один файл(а иногда это необходимо), и их возможно разделить на скажем функции работы с файловой системой, работы с шаблонами и буфером вывода, и т.д., как самому не запутаться в таком файле, и сделать его понятным дркгим.
Мелкий спасибо, со стилем JavaDoc не знаком, почитаю.
9. Champion - 21 Июля, 2011 - 20:23:06 - перейти к сообщению
White пишет:
а иногда это необходимо
А например когда?
10. White - 21 Июля, 2011 - 22:48:46 - перейти к сообщению
Champion а например в случае production версии фреймворка или ядра cms. в моих разработках колличество строк одного ядра иногда доходит до 1500 - 2000, а ведь это совсем не много...
11. Champion - 22 Июля, 2011 - 09:12:25 - перейти к сообщению
Я не увидел здесь причин, обязывающих писать всё в один файл. Почему ядро не может быть поделено на отдельные модули?
12. White - 22 Июля, 2011 - 10:28:54 - перейти к сообщению
Champion а какой в этом смысл? ядро само по себе не выполняет действий, лишь объявляет функции и классы, тесно взаимодействующие между собой, и поэтому для нормальной работы необходимо одновременно иметь под рукой их все. выпадание какой либо из них делает неработоспособной всю систему, и по этому можно сказать что ядро это одно целое. ИМХО файлы стоит делить на части только тогда, когда каждая из этих частей может работать без остальных, т.е являться самостоятельной единицей, а делить на части целое, чтобы потом каждый раз все равно собирать их вместе не имеет смысла.
Далее, модулем ядра назовем определенный набор функций, использующих ядро, но не используемых ядром. Т.е. ядро может работать без модуля, модуль без ядра нет. Модули я выношу в отдельные файлы.
П.С. Естественно это не касается процесса разработки. Как я уже сказал в своем первом посте
White пишет:
В процессе разработки каждый блок вынесен в отдельный файл
13. EuGen - 22 Июля, 2011 - 10:32:55 - перейти к сообщению
http://ru[dot]wikipedia[dot]org/wiki/PHPDoc

http://www.phpdoc[dot]org/

http://ru[dot]wikipedia[dot]org/wiki/PhpDocumentor
14. Champion - 22 Июля, 2011 - 10:54:55 - перейти к сообщению
Ну можно хранить логически разные вещи в разных модулях, а какой-нибудь один главный модуль ядра пусть их все инклюдит.
Смысл - разделить разный по смыслу функционал по отдельным местам. То, что они все не могут существовать друг без друга, не значит, что они все должны быть в одном файле.
White пишет:
В процессе разработки каждый блок вынесен в отдельный файл
Вот. Правильно. А после разработки происходит поддержка как правило, а поддерживать, когда всё свалено в одну кучу не очень удобно по тем же причинам, по которым не удобно разрабатывать, когда свалено в кучу.
Но, в принципе, это не более, чем моя точка зрения, я ее не навязываю.
15. White - 22 Июля, 2011 - 11:14:37 - перейти к сообщению
EuGen Спасибо, то что надо.
Champion Возможно тогда стоит просто иметь 2 версии: production и development, как это часто и делается, так как поддержка может осуществляться сторонними программистами. спасибо, учту ваше мнение

 

Powered by ExBB FM 1.0 RC1