【WIP】phpDocumentor を使って簡単にドキュメントを自動生成してみる

.gitignore

@@ -74,3 +74,5 @@ fabric.properties
 # End of https://www.gitignore.io/api/phpstorm
 
 /vendor/
+
+composer.lock

composer.json

@@ -8,5 +8,9 @@
     ],
 
     "require": {
+    },
+    "require-dev": {
+        "phpdocumentor/phpdocumentor": "^2.9",
+        "jms/serializer": "1.7.*"
     }
 }

phpDoc/src/Animal.php

@@ -0,0 +1,47 @@
+<?php
+
+class Animal
+{
+    protected $name;
+    protected $voice;
+
+
+    public function __construct($name, $voice = 'わんわん')
+    {
+        $this->name = $name;
+        $this->voice = $voice;
+
+    }
+
+    public function bark()
+    {
+      echo $this->voice;
+    }
+
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    public function setName($name)
+    {
+        if(isset($name)){
+            return 'please my name';
+        }
+
+        $this->name = $name;
+    }
+}
+
+
+$dog = new Animal('Dog');
+$name = $dog->getName();
+echo  $name;
+$dog->bark();
+
+
+$cat = new Animal('Cat','ニャーニャー');
+$cat->getName();
+$name = $cat->getName();
+echo  $name;
+$cat->bark();