PDA

Просмотр полной версии : файлы readme и комменты в скриптах


Дикс
03.03.2008, 13:07
Может кто-нить меня просветить на тему составления комментов в скриптах? Ну я о тех шапках, которые вставляются в каждый скрипт, по типу


/*================================================= =====================*\
|| ################################################## ################## ||
|| # vBulletin 3.6.8 Patch Level 1 - Licence Number VBFB92785D
|| # ---------------------------------------------------------------- # ||
|| # Copyright ©2000-2007 Jelsoft Enterprises Ltd. All Rights Reserved. ||
|| # This file may not be redistributed in whole or significant part. # ||
|| # ---------------- VBULLETIN IS NOT FREE SOFTWARE ---------------- # ||
|| # http://www.vbulletin.com | http://www.vbulletin.com/license.html # ||
|| ################################################## ################## ||
\*================================================ ======================*/


и футер

/*================================================= =====================*\
|| ################################################## ##################
|| # Downloaded: 05:05, Sun Oct 28th 2007
|| # CVS: $RCSfile$ - $Revision: 15988 $
|| ################################################## ##################
\*================================================ ======================*/


в частности, меня интересует назначение знаков доллара
# CVS: $RCSfile$ - $Revision: 15988 $

$Id: README 11046 2008-01-12 12:18:49Z lem9 $

што эт за разметка хитрая? она для каких-то парсеров?
зачем нужно писать "$id" ?

spider-intruder
03.03.2008, 13:37
В принципе не для чего - хотя возможна автор изменяет некоторые значения в коментах парсером и юзает для этого спецсимвол - в даном случае доллар

Возможно автор написал скрипт который заменяет версию билда во всех коментах. Он знает, что первым в коментах идет версия скрипта

Делает Explode и заменяет даные на другие

Noiro
03.03.2008, 13:46
$Id$ и прочее - это keywords систем контроля версий.
При коммитте они автоматически делают замену. В часности $Id$ включает в себя номер ревизии, дату коммитта, и автора в Subversion.

Дикс
03.03.2008, 15:00
спасибо