Spear
почемучка
Комментирование кода: колонтитулы - как правильно их составлять?
Доброе утро,
у меня в недавнем времени появилась необходимость красиво комментировать свой код, т.к. сейчас разрабатываю довольно крупный проект.
О том как комментировать код, вприцнипе, осведомлен (для phpDocumentator), но меня интересует вот что - как правильно составлять колонтитулы (шапку) РНР-документа?
Есть какие-то программы (или плагины к редактору Zend или Notepad++ (раньше только его и использовал, пока не получил Zend))?
Вот, например, посмотрел исходник форума Invision, там такая шапка:
первые строчки конечно и руками можно вбить (1 раз, потом копи-паст) но все остальное - тут наверное без отдельного софта не обходится?
Поделитесь вашим опытом, пожалуйста - как грамотно вести такие колонтитулы?
-~{}~ 25.02.07 11:14:
и ещё появился вопросик по поводу контроля версий - я пока в этом всем только разбираюсь, но: если я использую в качестве сервера http://svn.collab.net/ - значит ли это что мои исходники будут закачаны на тот сервер и любой желающий сможет их вытянуть? Или я неправильно понимаю принцип работы системы?
Доброе утро,
у меня в недавнем времени появилась необходимость красиво комментировать свой код, т.к. сейчас разрабатываю довольно крупный проект.
О том как комментировать код, вприцнипе, осведомлен (для phpDocumentator), но меня интересует вот что - как правильно составлять колонтитулы (шапку) РНР-документа?
Есть какие-то программы (или плагины к редактору Zend или Notepad++ (раньше только его и использовал, пока не получил Zend))?
Вот, например, посмотрел исходник форума Invision, там такая шапка:
PHP:
/*
+--------------------------------------------------------------------------
| Invision Power Board
| =============================================
| by Matthew Mecham
| (c) 2001 - 2006 Invision Power Services, Inc.
| =============================================
+---------------------------------------------------------------------------
| > $Date: 2006-12-11 17:58:35 -0500 (Mon, 11 Dec 2006) $
| > $Revision: 783 $
| > $Author: bfarber $
+---------------------------------------------------------------------------
|
| > Admin Forum functions
| > Module written by Matt Mecham
| > Date started: 1st march 2002
|
| > Module Version Number: 1.0.0
| > DBA Checked: Mon 24th May 2004
+--------------------------------------------------------------------------
*/Поделитесь вашим опытом, пожалуйста - как грамотно вести такие колонтитулы?
-~{}~ 25.02.07 11:14:
и ещё появился вопросик по поводу контроля версий - я пока в этом всем только разбираюсь, но: если я использую в качестве сервера http://svn.collab.net/ - значит ли это что мои исходники будут закачаны на тот сервер и любой желающий сможет их вытянуть? Или я неправильно понимаю принцип работы системы?
TortoiseSVN это лишь графическая оболочка для svn клиента, поэтому там основополагающих вещей в документации можно и не найти. А вот в официальной Subversion Book есть целый раздел про это: