-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathphp-phpdoc.html
More file actions
746 lines (644 loc) · 36.1 KB
/
php-phpdoc.html
File metadata and controls
746 lines (644 loc) · 36.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>PHPDocのフォーマット | SOCKET-MANAGER Framework For PHP</title>
<meta name="description" content="PHPDocコメントの詳細な書き方を解説。VSCodeでのツールチップ表示、phpDocumentorでの出力例、クラス/メソッド/プロパティのコメント記法など、具体的なコード例と実際の表示結果で分かりやすく紹介。" />
<meta content="PHP,PHPDoc,VSCode,phpDocumentor,markdown,ソケットマネージャー" name="keywords">
<link rel="canonical" href="https://socket-manager.github.io/document/php-phpdoc.html" />
<script async src="https://www.googletagmanager.com/gtag/js?id=G-LF9W695NNW"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-LF9W695NNW');
</script>
<link rel="icon" href="https://socket-manager.github.io/document/favicon.ico" type="image/x-icon" />
<link type="text/css" rel="stylesheet" href="./css/common.css" media="all" />
<script src="./js/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="./js/common.js"></script>
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "TechArticle",
"headline": "PHPDocコメントの書き方・実装ガイド",
"description": "PHPDocコメントの詳細な書き方を解説。VSCodeでのツールチップ表示、phpDocumentorでの出力例、クラス/メソッド/プロパティのコメント記法など、具体的なコード例と実際の表示結果で分かりやすく紹介。",
"keywords": "PHPDoc, PHP, VSCode, phpDocumentor",
"articleSection": ["Technical Documentation", "PHP Programming"],
"image": "https://socket-manager.github.io/document/img/php-phpdoc/header-file.png",
"author": {
"@type": "Person",
"name": "SOCKET-MANAGER開発チーム"
},
"publisher": {
"@type": "Organization",
"name": "SOCKET-MANAGER",
"logo": {
"@type": "ImageObject",
"url": "https://socket-manager.github.io/document/logo.png",
"width": 355,
"height": 50
}
},
"mainEntityOfPage": {
"@type": "WebPage",
"@id": "https://socket-manager.github.io/document/php-phpdoc.html"
},
"url": "https://socket-manager.github.io/document/php-phpdoc.html",
"breadcrumb": {
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "Framework Top",
"item": "https://socket-manager.github.io/document/"
},{
"@type": "ListItem",
"position": 2,
"name": "PHPDocのフォーマット",
"item": "https://socket-manager.github.io/document/php-phpdoc.html"
}]
},
"tutorial": {
"@type": "HowTo",
"name": "PHPDocコメント記法の解説",
"step": [
{
"@type": "HowToStep",
"name": "ドキュメント生成",
"text": "phpDocumentorによるドキュメント出力方法"
},
{
"@type": "HowToStep",
"name": "コメントの記述",
"text": "各種タグとmarkdown記法の使用方法"
}
]
},
"isPartOf": {
"@type": "WebSite",
"name": "フレームワークのご紹介",
"url": "https://socket-manager.github.io/document/"
}
}
</script>
</head>
<body>
<div class="layout">
<div class="menu" role="navigation" aria-label="ページメニュー">
<h2 class="menu-title">SOCKET-MANAGER</h2>
<h4 class="menu-reference menu-page-title-bottom"><a href="./reference/" target="_blank">>> Reference</a></h4>
<h2 class="menu-label">MAIN-MENU</h2>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./">▶フレームワークのご紹介</a></h3>
<h3 class="menu-page-title-link"><a href="./event-handler.html">▶イベントハンドラについて</a></h3>
</div>
<h3 class="menu-label-sub">IMPLEMENT</h3>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./init-class.html">▶初期化クラス</a></h3>
<h3 class="menu-page-title-link"><a href="./unit-parameter.html">▶UNITパラメータクラス</a></h3>
<h3 class="menu-page-title-link"><a href="./protocol-unit.html">▶プロトコルUNITクラス</a></h3>
<h3 class="menu-page-title-link"><a href="./command-unit.html">▶コマンドUNITクラス</a></h3>
<h3 class="menu-page-title-link"><a href="./main.html">▶メイン処理クラス</a></h3>
<h3 class="menu-page-title-link"><a href="./setting.html">▶設定ファイル</a></h3>
<h3 class="menu-page-title-link"><a href="./message.html">▶メッセージファイル</a></h3>
</div>
<div class="menu-line"></div>
<div class="menu-text">
<h3 class="menu-page-title-link-for-runtime-manager"><a href="./runtime-manager/" target="_blank">>> ランタイムライブラリ</a></h3>
<h3 class="menu-page-title-link-for-runtime-manager"><a href="./simple-socket/" target="_blank">>> シンプルソケット機能</a></h3>
</div>
<h3 class="menu-label-sub">ADVANCED</h3>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./architecture.html">▶アーキテクチャ</a></h3>
<h3 class="menu-page-title-link"><a href="./event.html">▶イベント駆動アーキテクチャ</a></h3>
<h3 class="menu-page-title-link"><a href="./ipc.html">▶IPC（プロセス間通信）</a></h3>
<h3 class="menu-page-title-link"><a href="./multi-server.html">▶マルチサーバーの構成</a></h3>
<h3 class="menu-page-title-link"><a href="./tcp-and-udp.html">▶TCP/UDP通信について</a></h3>
<h3 class="menu-page-title-link"><a href="./laravel.html">▶Laravelと連携する</a></h3>
<h3 class="menu-page-title-link"><a href="./system-setting.html">▶システム設定ファイル</a></h3>
<h3 class="menu-page-title-link"><a href="./custom-command.html">▶カスタムコマンド作成機能</a></h3>
</div>
<h3 class="menu-label-sub">OTHER-PROJECT</h3>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./new-project.html">▶新規開発環境</a></h3>
<h3 class="menu-page-title-link"><a href="./websocket.html">▶Websocketサーバー開発環境</a></h3>
<h3 class="menu-page-title-link"><a href="./dev-ops.html">▶フレームワークのDevOps環境</a></h3>
</div>
<div class="menu-line"></div>
<div class="menu-text">
<h3 class="menu-page-title-link-for-minecraft"><a href="./minecraft-contents/" target="_blank">>> マインクラフト専用環境</a></h3>
<h3 class="menu-page-title-link-for-launcher"><a href="./launcher/" target="_blank">>> GUI & CLI ランチャー</a></h3>
<h3 class="menu-page-title-link-for-rest-api"><a href="./rest-api/" target="_blank">>> REST-APIサーバー開発環境</a></h3>
</div>
<h2 class="menu-label">EXTRA-MENU</h2>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./extra-demo.html">▶デモサーバーの種類</a></h3>
<h3 class="menu-page-title-link"><a href="./extra-demo-command.html">▶デモのコマンド仕様</a></h3>
<h3 class="menu-page-title-link"><a href="./extra-demo-setting.html">▶デモの設定ファイル</a></h3>
<h3 class="menu-page-title-link"><a href="./extra-minecraft.html">▶マインクラフトの通信仕様</a></h3>
<h3 class="menu-page-title-link"><a href="./extra-close-frame.html">▶切断フレームの検証</a></h3>
</div>
<h2 class="menu-label">PHP-TECHNIQUE</h2>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./php-pass-by-reference.html">▶参照渡し</a></h3>
<h3 class="menu-page-title">▼PHPDocのフォーマット</h3>
<ul>
<li><a href="./php-phpdoc.html#begin">はじめに</a></li>
</ul>
<ul>
<li><a href="./php-phpdoc.html#env">動作環境</a></li>
</ul>
<ul>
<li><a href="./php-phpdoc.html#command">PHPDoc出力コマンド</a></li>
</ul>
<ul>
<li><a href="./php-phpdoc.html#header">ヘッダコメント</a></li>
</ul>
<ul>
<li><a href="./php-phpdoc.html#property">プロパティ</a></li>
</ul>
<ul>
<li><a href="./php-phpdoc.html#common">共通（インライン可能）タグ</a></li>
</ul>
</div>
<div class="menu-dummy-for-framework"></div>
</div>
<div class="main" role="main">
<h1>【PHPDocのフォーマット】</h1>
<a id="begin"></a>
<h2 class="subtitle">はじめに</h2>
<div class="text-block">
当フレームワークではPHPDocをコメントフォーマットとして採用していますので、ライブラリ上のPHPDocの出力結果を<font><a href="./reference/index.html" target="_blank">>> Reference</a></font>として公開しています。<br />
以下ではコメント記載時の備忘録として、IDEの１つであるVSCodeのツールチップとPHPDoc出力後のイメージを抱き合わせで掲載しています。<br/>
</div><br/>
<a id="env"></a>
<h2 class="subtitle">動作環境</h2>
<div class="text-block">
<dl>
<dt>プラットフォーム</dt>
<dd>Windows10</dd>
<dt>PHPDoc</dt>
<dd>phpDocumentor v3.5.3</dd>
<dt>IDE</dt>
<dd>VSCode v1.94.0</dd>
</dl>
</div><br />
<a id="command"></a>
<h2 class="subtitle">PHPDoc出力コマンド</h2>
<div class="text-block">
ファイル構成が以下の場合。<br />
<dl>
<dt>phpDocumentorの実行ファイル</dt>
<dd>カレントディレクトリ</dd>
<dt>ソースファイル</dt>
<dd>カレントの<code>src</code>ディレクトリ内</dd>
<dt>PHPDoc出力先</dt>
<dd>カレントの<code>doc</code>ディレクトリ内</dd>
</dl>
<pre color-change="command" aria-label="PHPDoc出力時のコマンドライン">
> php ./phpDocumentor.phar run -d ./src -t ./doc
</pre><br />
※<code>phpDocumentor.phar</code>のファイルは<font><a href="https://phpdoc.org/" target="_blank">>> こちら</a></font>のページからダウンロードできます。
</div><br />
<a id="header"></a>
<h2 class="subtitle">ヘッダコメント</h2>
<div class="text-block">
<br />
<h3 class="underline">ファイルヘッダ</h3>
<pre color-change="php" aria-label="ソース">
<?php
/**
* ファイルのタイトル的なもの
*
* ファイル内容の説明的なもの
*
* @license GPL
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @author 名前 <my.name@example.com>
* @copyright 1997-2005 The PHP Group
*/
</pre><br />
<dl>
<dt>・コメントフォーマット</dt>
<dd>
<dl>
<dt>ファイルのタイトル的なもの</dt>
<dd>
概要を簡潔に１行以内に収めるのが好ましい。<br />
</dd>
<dt>ファイル内容の説明的なもの</dt>
<dd>説明文や補足的なものを書く。</dd>
</dl>
</dd>
</dl><br />
<dl>
<dt>・タグフォーマット</dt>
<dd>
<dl>
<dt>@license [<url>] [name]</dt>
<dd>
ファイル単位で書くのが好ましい。<br />
複数ライセンスの存在があり得る。<br />
url（省略可能）にはライセンス対象のURLを書く。<br />
</dd>
<dt>@author [name] [<email address>]</dt>
<dd>[name]は省略可能。</dd>
<dt>@copyright [description]</dt>
<dd></dd>
</dl>
</dd>
</dl><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
なし<br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/header-file.png" width="562px" loading="lazy" alt="ファイルヘッダのPHPDoc出力イメージ" /><br />
</dd>
</dl>
<br />
<h3 class="underline">クラスヘッダ（親クラスがある場合）</h3>
<pre color-change="php" aria-label="ソース">
/**
* 子クラスのタイトル的なもの
*
* 子クラスの説明的なもの
*
* @property string $my_property 子クラス側のプロパティ説明
* @method string getString() 子クラス側の文字列データ取得メソッドの説明
* @method void setString(string $data) 子クラス側の文字列データ設定メソッドの説明
*/
class ChildClass extends ParentClass
</pre><br />
<dl>
<dt>・コメントフォーマット</dt>
<dd>
<dl>
<dt>子クラスのタイトル的なもの</dt>
<dd>
概要を簡潔に１行以内に収めるのが好ましい。<br />
</dd>
<dt>子クラス内容の説明的なもの</dt>
<dd>説明文や補足的なものを書く。</dd>
</dl>
</dd>
</dl><br />
<dl>
<dt>・タグフォーマット</dt>
<dd>
<dl>
<dt>@property [Type] [name] [<description>]</dt>
<dd>
<code>__get</code>または<code>__set</code>マジックメソッドが親クラスに存在する場合、有効なプロパティを指定する。<br />
</dd>
<dt>@method [return type] [name]([[type] [parameter]<, ...>]) [<description>]</dt>
<dd>
<code>__call</code>マジックメソッドが親クラスに存在する場合、呼び出し可能なメソッドを指定する。<br />
</dd>
</dl>
</dd>
</dl><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-header-class.png" width="572px" loading="lazy" alt="クラスヘッダ（親クラスがある場合）のツールチップイメージ" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/header-class.png" width="626px" loading="lazy" alt="クラスヘッダ（親クラスがある場合）のPHPDoc出力イメージ" /><br />
鍵マークが付いているのが親クラスのprivateメンバーです。<br />
マジックメソッドも含めて親クラスのメンバーと混合で表示されるので注意が必要。
</dd>
</dl>
<br />
<h3 class="underline">関数（またはメソッド）ヘッダ</h3>
<pre color-change="php" aria-label="ソース">
/**
* 関数（またはメソッド）のタイトル的なもの
*
* 関数（またはメソッド）の説明的なもの
*
* @since 1.0.2 $type_int引数の追加
* @since 1.0.1 $type_string引数の追加
* @since 1.0.0
*
* @param string $type_string 文字列データ
* @param int $type_int 整数データ
* @param bool $type_bool ブール値（true or false）データ
* @param float $type_float 浮動小数点数データ
* @param object $type_object 型を特定しないインスタンスデータ
* @param mixed $type_mixed 型を特定しないデータ
* @param array $type_array 配列データ
* @param callable $type_callable コールバック
* @param self $type_self 自身のインスタンスデータ
* @return string | null 文字列データ or null
* @throws Exception ネイティブな例外クラス
* @throws \Phpdoc\Sample\CustomException カスタム例外クラス
*/
public function exampleFunction
(
string $type_string,
int $type_int,
bool $type_bool,
float $type_float,
object $type_object,
$type_mixed,
array $type_array,
$type_callable,
self $type_self
)
</pre><br />
<dl>
<dt>・コメントフォーマット</dt>
<dd>
<dl>
<dt>関数（またはメソッド）のタイトル的なもの</dt>
<dd>
概要を簡潔に１行以内に収めるのが好ましい。<br />
</dd>
<dt>関数（またはメソッド）内容の説明的なもの</dt>
<dd>説明文や補足的なものを書く。</dd>
</dl>
</dd>
</dl><br />
<dl>
<dt>・タグフォーマット</dt>
<dd>
<dl>
<dt>@since [version] [<description>]</dt>
<dd>
バージョンに伴う更新履歴。<br />
</dd>
<dt>@param [Type] [name] [<description>]</dt>
<dd>
引数の型、変数名、説明を記載する。<br />
</dd>
<dt>@return [Type] [<description>]</dt>
<dd>
戻り値の型、説明を記載する。<br />
型はor演算子（'|'）で区切って複数指定可能。
</dd>
<dt>@throws [Type] [<description>]</dt>
<dd>
例外の型、説明を記載する。
</dd>
</dl>
</dd>
</dl><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-header-method1.png" width="438px" loading="lazy" alt="関数（またはメソッド）ヘッダのツールチップイメージ（分割イメージの１つ目）" /><br />
<img src="./img/php-phpdoc/tooltip-header-method2.png" width="438px" loading="lazy" alt="関数（またはメソッド）ヘッダのツールチップイメージ（分割イメージの２つ目）" /><br />
<img src="./img/php-phpdoc/tooltip-header-method3.png" width="440px" loading="lazy" alt="関数（またはメソッド）ヘッダのツールチップイメージ（分割イメージの３つ目）" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/header-method1.png" width="633px" loading="lazy" alt="関数（またはメソッド）ヘッダのPHPDoc出力イメージ（分割イメージの１つ目）" /><br />
<img src="./img/php-phpdoc/header-method2.png" width="631px" loading="lazy" alt="関数（またはメソッド）ヘッダのPHPDoc出力イメージ（分割イメージの２つ目）" /><br />
</dd>
</dl>
</div><br />
<a id="property"></a>
<h2 class="subtitle">プロパティ</h2>
<div class="text-block">
共通タグフォーマット
<dl>
<dt>@var [Type] [$element_name] [<description>]</dt>
<dd>
[Type]データ型<br />
[$element_name]プロパティ名<br />
[<description>]データの説明<br />
</dd>
</dl><br />
<br />
<h3 class="underline">文字列（string）型</h3>
<pre color-change="php" aria-label="ソース">
/**
* 文章での説明が必要な時はここに書く
*
* @var string | null $type_string 文字列データ or null
*/
public ?string $type_string;
</pre><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-property-string.png" width="386px" loading="lazy" alt="文字列（string）型プロパティのツールチップイメージ" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/property-string.png" width="632px" loading="lazy" alt="文字列（string）型プロパティのPHPDoc出力イメージ" /><br />
</dd>
</dl>
<br />
<h3 class="underline">整数（int）型</h3>
<pre color-change="php" aria-label="ソース">
/** @var int $type_int 整数データ */
public int $type_int;
</pre><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-property-int.png" width="252px" loading="lazy" alt="整数（int）型プロパティのツールチップイメージ" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/property-int.png" width="629px" loading="lazy" alt="整数（int）型プロパティのPHPDoc出力イメージ" /><br />
</dd>
</dl>
<br />
<h3 class="underline">ブール（bool）型</h3>
<pre color-change="php" aria-label="ソース">
/** @var bool $type_bool ブール値（true or false）データ */
public bool $type_bool;
</pre><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-property-bool.png" width="377px" loading="lazy" alt="ブール（bool）型プロパティのツールチップイメージ" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/property-bool.png" width="634px" loading="lazy" alt="ブール（bool）型プロパティのPHPDoc出力イメージ" /><br />
</dd>
</dl>
<br />
<h3 class="underline">浮動小数点数（float）型</h3>
<pre color-change="php" aria-label="ソース">
/** @var float $type_float 浮動小数点数データ */
public float $type_float;
</pre><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-property-float.png" width="330px" loading="lazy" alt="浮動小数点数（float）型プロパティのツールチップイメージ" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/property-float.png" width="629px" loading="lazy" alt="浮動小数点数（float）型プロパティのPHPDoc出力イメージ" /><br />
</dd>
</dl>
<br />
<h3 class="underline">オブジェクト（object）型</h3>
<pre color-change="php" aria-label="ソース">
/** @var object $type_object 型を特定しないインスタンスデータ */
public object $type_object;
</pre><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-property-object.png" width="410px" loading="lazy" alt="オブジェクト（object）型プロパティのツールチップイメージ" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/property-object.png" width="633px" loading="lazy" alt="オブジェクト（object）型プロパティのPHPDoc出力イメージ" /><br />
</dd>
</dl>
<br />
<h3 class="underline">型指定なし（mixed）</h3>
<pre color-change="php" aria-label="ソース">
/** @var mixed $type_mixed 型を特定しないデータ */
public $type_mixed;
</pre><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-property-mixed.png" width="332px" loading="lazy" alt="型指定なし（mixed）プロパティのツールチップイメージ" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/property-mixed.png" width="632px" loading="lazy" alt="型指定なし（mixed）プロパティのPHPDoc出力イメージ" /><br />
</dd>
</dl>
<br />
<h3 class="underline">配列（array）型</h3>
<pre color-change="php" aria-label="ソース">
/** @var array $type_array 配列データ */
public array $type_array;
</pre><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-property-array.png" width="276px" loading="lazy" alt="配列（array）型プロパティのツールチップイメージ" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/property-array.png" width="636px" loading="lazy" alt="配列（array）型プロパティのPHPDoc出力イメージ" /><br />
</dd>
</dl>
<br />
<h3 class="underline">コールバック（callable）型</h3>
<pre color-change="php" aria-label="ソース">
/** @var callable $type_callable コールバック */
public $type_callable;
</pre><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-property-callable.png" width="324px" loading="lazy" alt="コールバック（callable）型プロパティのツールチップイメージ" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/property-callable.png" width="631px" loading="lazy" alt="コールバック（callable）型プロパティのPHPDoc出力イメージ" /><br />
</dd>
</dl>
</div><br />
<a id="common"></a>
<h2 class="subtitle">共通（インライン可能）タグ</h2>
<div class="text-block">
<pre color-change="php" aria-label="ソース">
/**
* 共通（インライン可能）タグ用
*
* * リスト表示１行目です
* * リスト表示２行目です
*
* ---
*
* １行目
* ２行目のつもり
*
* ３行目
*
* ---
*
* # マークダウン１
*
* 親クラスのプロパティ（{@see ParentClass::$items 継承プロパティ}）を継承します。
*
* ## マークダウン２
*
* リンク先のドキュメント（{@link http://example.com/ ドキュメント}）をご覧ください。
*
* ### マークダウン３
*
* @see http://example.com/ ドキュメントのタイトルなど
* @see ParentClass::$items 関連するクラスプロパティの説明
* @see ParentClass::setItems() 関連するクラスメソッドの説明
* @link http://example.com/ リンク先ページ名
*/
protected $items;
</pre><br />
<dl>
<dt>・マークダウン記法</dt>
<dd>
<dl>
<dt>* <description></dt>
<dd>
リスト（箇条書き）で表示可能。<br />
</dd>
<dt>---</dt>
<dd>横線を引く事が可能。</dd>
<dt># <title></dt>
<dd>大きな文字で見出し表示可能。</dd>
<dt>## <title></dt>
<dd>２番目に大きな文字で見出し表示可能。</dd>
<dt>### <title></dt>
<dd>３番目に大きな文字で見出し表示可能。</dd>
<dt>改行指定</dt>
<dd>
空行を挟む事によって改行表示となる。<br />
空行を挟まない場合は１行とみなされる。
</dd>
</dl>
</dd>
</dl><br />
<dl>
<dt>・タグフォーマット</dt>
<dd>
<dl>
<dt>@see [URI | FQSEN] [<description>]</dt>
<dd>
FQSENは完全修飾要素名。<br />
{}括弧で囲む事によってインライン指定可能。<br />
[URI | FQSEN]は省略可能。
</dd>
<dt>@link [URI] [<description>]</dt>
<dd>
参考資料等のリンクURIとリンク文字を指定可能。<br />
{}括弧で囲む事によってインライン指定可能。
</dd>
</dl>
</dd>
</dl><br />
<dl>
<dt>－ツールチップ－</dt>
<dd>
<img src="./img/php-phpdoc/tooltip-common1.png" width="432px" loading="lazy" alt="共通（インライン可能）タグのツールチップイメージ（分割イメージの１つ目）" /><br />
<img src="./img/php-phpdoc/tooltip-common2.png" width="433px" loading="lazy" alt="共通（インライン可能）タグのツールチップイメージ（分割イメージの２つ目）" /><br /><br />
</dd>
<dt>－出力イメージ－</dt>
<dd>
<img src="./img/php-phpdoc/common.png" width="630px" loading="lazy" alt="共通（インライン可能）タグのPHPDoc出力イメージ" /><br />
</dd>
</dl>
</div><br />
</div>
</div>
</body>
</html>