[ Поиск ] - [ Пользователи ] - [ Календарь ]
Полная Версия: Стандарт оформления документации по функциям.
LRCenter
Заканчиваю писать библиотеку из более чем 20 функций.
Не знаю вот как правильно оформить документацию.

В официальной документации по php, все как то наворочено оформлено.

Например - http://www.php.su/functions/?str_replace

Помимо вербального описания сути работы(эффекта) функции, и возвращаемых данных, есть еще какая-то вата:

mixed str_replace ( mixed search, mixed replace, mixed subject [, int &count] )


Что это такое? И как это читать?



Спустя 1 час, 19 минут, 11 секунд (11.02.2011 - 11:56) linker написал(а):
mixed - означает любой (один из нескольких возможных) тип значения
mixed str_replace() - может возвращать любой (один из нескольких возможных) тип значений
mixed search - говорит, что принимает любой (нодин из нескольких возможных) тип значения для параметра search
и т.д.
[] - означает необязательный параметр
[,] - означает любое количество необязательных параметров
int count - требуется целочисленное значение для параметра count
& - указывает что параметр будет ссылкой на передаваемую переменную
int &count - говорит, что для параметра count ОБЯЗАТЕЛЬНО нужно передать переменную, например, так нельзя
function a(&b) {}
a('sss');
можно только так
function a(&b) {}
$s = 'sss';
a($s);

Спустя 39 минут, 24 секунды (11.02.2011 - 12:36) LRCenter написал(а):
Ну спасибо, linker, ну спасибо, дорогой!
Тебе уже скоро как Брежневу ордена будет некуда вешать biggrin.gif biggrin.gif
Карму пока не могу поднять - форум не дает так часто.
Откуда только у тебя такие энциклопедические познания? Везде искал - нигде не нашел такой инфы!

--

Кстати, библиотечка моя(СУБД типа) почти готова, осталось пару функций дописать (всего около 25 получилось), потестить хорошенько и документацию сопроводительную написать, с примерами.

Посеревнуемся скоро?

Думаю вот цмс свою что-ли написать на ее основе? Есть кое-какие наработки...

Спустя 1 час, 2 минуты, 31 секунда (11.02.2011 - 13:38) linker написал(а):
Многолетний опыт, ну и это как бы являются общепризнанными условными обозначениями. В книжках такого добра навалом.

Обязательно smile.gif


_____________
Меньше кода - меньше багов ©
Быстрый ответ:

 Графические смайлики |  Показывать подпись
Здесь расположена полная версия этой страницы.
Invision Power Board © 2001-2024 Invision Power Services, Inc.