svn: /phpdoc/ru/trunk/appendices/ userlandnaming.xml
| From: | Shein Alexey | Date: | Wed, 03 Aug 2011 10:38:06 +0000 |
| Subject: | svn: /phpdoc/ru/trunk/appendices/ userlandnaming.xml | ||
| Groups: | php.doc.ru | ||
| Request: | Send a blank email to doc-ru+get-2130@lists.php.net to get a copy of this message | ||
shein Wed, 03 Aug 2011 10:38:06 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=314143
Log:
Updated userlandnaming translation from Alexzzam.
Changed paths:
A + phpdoc/ru/trunk/appendices/userlandnaming.xml
(from phpdoc/en/trunk/appendices/userlandnaming.xml:r314133)
Copied: phpdoc/ru/trunk/appendices/userlandnaming.xml (from rev 314133,
phpdoc/en/trunk/appendices/userlandnaming.xml)
===================================================================
--- phpdoc/ru/trunk/appendices/userlandnaming.xml (rev 0)
+++ phpdoc/ru/trunk/appendices/userlandnaming.xml 2011-08-03 10:38:06 UTC (rev 314143)
@@ -0,0 +1,137 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: 304887 Maintainer: shein Status: ready -->
+<!-- Reviewed: no -->
+<!-- $Revision$ -->
+<appendix xml:id="userlandnaming" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title>Руководство по именованию</title>
+ <para>
+ Этот документ содержит советы по выбору имён для
идентификаторов PHP-кода.
+ При выборе имён для кода, создающего идентификаторы
в глобальном пространстве
+ имён, важно принимать во внимание это руководство,
чтобы избежать
+ коллизий имён из будущих версий PHP с вашим кодом.
+ </para>
+
+ <section xml:id="userlandnaming.globalnamespace">
+ <title>Глобальное пространство имён</title>
+ <para>
+ Обзор конструкций, создающих идентификаторы в
глобальном пространстве имён.
+ </para>
+
+ <itemizedlist>
+ <listitem><para>функции</para></listitem>
+ <listitem><para>классы</para></listitem>
+ <listitem><para>интерфейсы</para></listitem>
+ <listitem><para>константы (не константы
классов)</para></listitem>
+ <listitem>
+ <para>переменные, объявленные вне
функций/методов</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section xml:id="userlandnaming.rules">
+ <title>Правила</title>
+ <para>
+ Следующий список правил дает обзор прав именования,
которые проект PHP
+ оставляет себе при выборе новых идентификаторов.
Полным руководством
+ является официальный "<link
xlink:href="&url.userlandnaming.cs;">Стандарт
+ написания кода</link>":
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ PHP владеет глобальным пространством имён, но
старается находить
+ описательные имена и избегать очевидных коллизий.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Имена функций используют подчёркивания между
словами, а имена классов
+ используют как <literal>camelCase</literal>, так и
<literal>PascalCase</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ PHP добавляет префикс к глобальным именам,
принадлежащим расширению
+ с именем этого расширения. (В прошлом было
множество исключений из этого
+ правила.) Например:
+ </para>
+
+ <itemizedlist>
+
<listitem><para><function>curl_close</function></para></listitem>
+
<listitem><para><function>mysql_query</function></para></listitem>
+ <listitem><para>PREG_SPLIT_DELIM_CAPTURE</para></listitem>
+ <listitem><para>new DOMDocument()</para></listitem>
+ <listitem>
+ <para>
+ <function>strpos</function> (пример исключения,
допущенного в прошлом)
+ </para>
+ </listitem>
+ <listitem><para>new SplFileObject()</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Тем не менее, итераторы и исключения просто
получают постфиксы
+ "<literal>Iterator</literal>" и
"<literal>Exception</literal>."
+ Примеры:
+ </para>
+ <itemizedlist>
+
<listitem><para><classname>ArrayIterator</classname></para></listitem>
+
<listitem><para><classname>LogicException</classname></para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ PHP резервирует все идентификаторы, начинающиеся с
<literal>__</literal>
+ как "магические". Рекомендуется не создавать
идентификаторов, начинающихся
+ с <literal>__</literal>, кроме как с целью использовать
документированную
+ "магическую" функциональность. Примеры:
+ </para>
+ <itemizedlist>
+
<listitem><para><function>__get</function></para></listitem>
+
<listitem><para><function>__autoload</function></para></listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section xml:id="userlandnaming.tips">
+ <title>Советы</title>
+ <para>
+ Для написания кода, защищённого от коллизий, в
будущем рекомендуется
+ добавлять префикс или суффикс ко всем именам в
глобальном пространстве имён.
+ Рекомендуется использовать 3-4буквенный префикс,
отделенный подчёркиванием.
+ Также для избежания коллизий между разными
проектами рекомендуется
+ разузнать о существующих префиксах (или суффиксах)
и, соответственно,
+ распространить информацию о выбранном вами
варианте. Примеры:
+ </para>
+
+ <itemizedlist>
+ <listitem><para>MyPx_someFunc()</para></listitem>
+ <listitem><para>Foo_Date</para></listitem>
+ <listitem><para>$asdf_dbh</para></listitem>
+ </itemizedlist>
+ </section>
+
+</appendix>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->