-
Шаблон для новых тем
В этой теме приведён общий шаблон для описания функций.
Если хотите создать свою тему с описанием какой-либо нативной/автовызываемой функции в SA:MP или опубликовать свою функцию, просто скопируйте содержимое из-под спойлера ниже и заполните его.
Код HTML:
[color=orange][b]Описание:[/b][/color]
[indent]<описание функции>[/indent]
[color=orange][b]Параметры:[/b][/color]
[indent]<параметр1> - <описание>
<параметр2> - <описание>
<...>
<параметрN> - <описание>
[/indent]
[color=orange][b]Возвращаемое значение:[/b][/color]
[indent]<Описание возвращаемого значения>[/indent]
[color=orange][b]Плюсы реализации:[/b][/color] <только для пользовательских функций, необязательное поле>
[list]
[*] <перечисление>
[*] <...>
[/list]
[color=orange][b]Минусы реализации:[/b][/color] <только для пользовательских функций, необязательное поле>
[list]
[*] <перечисление>
[*] <...>
[/list]
[color=orange][b]Код:[/b][/color] <только для пользовательских функций>
[php]
<Код функции>
[/php]
[color=orange][b]Примечания:[/b][/color][list] <необязательный пункт>
[*]<...>
[*]<...>
[/list]
[color=orange][b]Пример использования:[/b][/color]
[php]
<Код примера>
[/php]
[color=orange][b]См. также:[/b][/color] <необязательный пункт>
[indent][url=<ссылка на статью #1>][color=#20c080][b][Native][/b][/color] <название статьи #1>[/url]
[url=<ссылка на статью #2>][color=#f08020][b][Callback][/b][/color] <название статьи #2>[/url]
[url=<ссылка на статью #3>][color=#5060ff][b][Function][/b][/color] <название статьи #3>[/url]
[/indent]
[b][color=orange]Автор:[/color][/b] [b]<Ваш никнейм>[/b] <только для пользовательских функций>
[b][color=orange]Статью подготовил:[/color][/b] [b]<Ваш никнейм>[/b]<только для нативных и автовызываемых функций>
Внимание: Не пытайтесь изменить цвет, шрифт и стиль подзаголовков или вносить ещё какие-либо свои изменения в шаблон. Серьёзно, в чём смысл шаблона, если каждый будет пытаться по-своему переделать его?
То же самое касается расположения строк и BB-кодов: не пытайтесь ставить лишние переносы и выносить BB-коды на новую строку. После каких-то пунктов в шаблоне присутствует лишняя пустая строка, после других нет - я сделал так специально, чтобы всё выглядело ровно, поскольку после некоторых BB-кодов ([list], [indent], etc.) и без переносов возникает лишнее пространство между строками.
Примеры использования на практике:
-
Переместил пункт "Примечания", поставив его перед пунктом "Пример использования", т.к. читателям может потребоваться сначала узнать особенности при работе с функцией, прежде чем смотреть на примеры кода.
Просьба ко всем, кто использовал этот шаблон, точно так же переместить вышеупомянутый пункт.
-
Добавил необязательный пункт "См. также". Впервые этот пункт был использован в статьях про функции gpci и PackHash, но так и не задокументирован до сих пор.
Также в этом пункте приведены примеры ссылок на статьи с нативными функциями, коллбэками и пользовательскими функциями. Форматирование текста ссылок прилагается.