Skip to content

Commit 66a4441

Browse files
committed
Add an appendix for example code in manual
php/doc-en@bce2cb8
1 parent 97fe6c8 commit 66a4441

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

appendices/examples.xml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<!-- EN-Revision: bce2cb849721c70737eb32ce958131e22677770c Maintainer: mumumu Status: ready -->
4+
<appendix xml:id="examples" xmlns="http://docbook.org/ns/docbook">
5+
<title>マニュアルのサンプルコードについて</title>
6+
<simpara>
7+
PHP のドキュメント中にあるたくさんのサンプルコードは、
8+
コードの明瞭さや簡潔さを優先したため、
9+
エラーや例外処理を省略している点に注意すべきです。
10+
</simpara>
11+
<simpara>
12+
これは、本番コードでエラー処理を省略すべきだという意味ではありません。
13+
エラー処理を省略すると、<exceptionname>TypeError</exceptionname>
14+
がスローされたり、&false; のような失敗を表す値が空文字列に強制変換されたり、
15+
仮定が破られることで追跡困難なバグが発生する可能性があるためです。
16+
拡張モジュールによっては、
17+
それが提供する様々なメソッドや関数の完全な使い方を示すために、
18+
エラー処理を含む完全な例を提供している場合もあります。
19+
</simpara>
20+
</appendix>
21+
<!-- Keep this comment at the end of the file
22+
Local variables:
23+
mode: sgml
24+
sgml-omittag:t
25+
sgml-shorttag:t
26+
sgml-minimize-attributes:nil
27+
sgml-always-quote-attributes:t
28+
sgml-indent-step:1
29+
sgml-indent-data:t
30+
indent-tabs-mode:nil
31+
sgml-parent-document:nil
32+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
33+
sgml-exposed-tags:nil
34+
sgml-local-catalogs:nil
35+
sgml-local-ecat-files:nil
36+
End:
37+
vim600: syn=xml fen fdm=syntax fdl=2 si
38+
vim: et tw=78 syn=sgml
39+
vi: ts=1 sw=1
40+
-->

0 commit comments

Comments
 (0)