| |
|
|
| | Не знал куда отнести тему, но вроде подходит под этот раздел. Допустим я пишу модуль на PHP, который затем распространяю. Я видел, как в верхней части модулей пишут информацию о модуле авторе версии и т.д. Я хотел спросить, а как правильно создавть вот это описание модуля? | |
| |
|
|
| |
|
|
| |
для: Sergey89
(29.05.2005 в 19:39)
| | | Вот я сам пидумал такое описание, что скажете?
Пример файла с описанием:
<?
//////////////////////////////////////////////////////////////////////////
// Имя файла: //
// config.php //
//----------------------------------------------------------------------//
// Название файла (модуля): //
// Конфигурационный файл. //
//----------------------------------------------------------------------//
// Описание: //
// Файл содержит ряд важных параметров, необходимых для правильной //
// работы портальной системы. Данный файл, предназначен для //
// самостоятельного редактирования пользователем. Ряд параметров //
// отмеченных "*" не рекомендуется редактировать самостоятельно //
//----------------------------------------------------------------------//
// Автор: //
// Федотов Сергей (sergey89@gmail.com, sergey89@mail.natm.ru) //
//----------------------------------------------------------------------//
// Дата создания файла: //
// 29.05.2005 //
//----------------------------------------------------------------------//
// Дата последнего редактирования: //
// 29.05.2005 //
//////////////////////////////////////////////////////////////////////////
#Подключение модулей
include("function.php"); //*Модуль функций
#Определение констант
define("MAIN_PATH", "E:/www/cms"); //Физический путь к файлам
define("MAIN_URL", "http://cms"); //Виртуальный путь к файлам
define("HEAD", MAIN_PATH."/head.php"); //*Верхний блок
define("FOOT", MAIN_PATH."/foot.php"); //*Нижний блок
#Настройки базы данных
$db["server"] = "localhost"; //Имя сервера
$db["user"] = "root"; //Имя пользователя
$db["password"] = ""; //Пароль
$db["name"] = "mlengine"; //Имя базы данных
dbconnect($db["server"], $db["user"], $db["password"], $db["name"]); //Соединение с базой данных
?>
|
| |
| |
|
|
| |
|
|
| |
для: Sergey89
(29.05.2005 в 22:56)
| | | Очень симпатично, только нет названия Web-приложения и завершающие символы // хоть и смотрятся красиво, но с ними сложно будет редактировать шапку, так как потребуется постоянное выравнивание левого края... | |
| |
|
|
| |
|
|
| |
для: Sergey89
(29.05.2005 в 19:39)
| | | Стандарта нет, обычно пишут название Web-приложения, ФИО разработчиков и их e-mail, по желанию можно привести тип лицензии. Далее следуют строки с датами последних модификаций файла - указывается дата, ФИО разработчика внёсшего изменения, его e-mail и краткое описание внесённых изменений. Если разработчик всего приложения один, то фамилию и e-mail в модификациях можно не указывать. | |
| |
|
|
