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