Add various comments in the codebase

Author: Antoine Makdessi

src/Controller/Admin/BlogController.php

@@ -30,7 +30,7 @@
  * purposes. However, in your real Symfony application you should use any of the
  * existing bundles that let you generate ready-to-use backends without effort.
  *
- * See http://knpbundles.com/keyword/admin
+ * See https://symfony.com/bundles/EasyAdminBundle/current/index.html
  *
  * @author Ryan Weaver <[email protected]>
  * @author Javier Eguiluz <[email protected]>

src/Controller/BlogController.php

@@ -75,12 +75,17 @@ public function index(Request $request, int $page, string $_format, PostReposito
     #[Route('/posts/{slug}', methods: ['GET'], name: 'blog_post')]
     public function postShow(Post $post): Response
     {
-        // Symfony's 'dump()' function is an improved version of PHP's 'var_dump()' but
+        // Symfony's 'dump()' and 'dd()' functions are an improved version of PHP's 'var_dump()' but
         // it's not available in the 'prod' environment to prevent leaking sensitive information.
         // It can be used both in PHP files and Twig templates, but it requires to
         // have enabled the DebugBundle. Uncomment the following line to see it in action:
         //
         // dump($post, $this->getUser(), new \DateTime());
+        // dd($post);
+        //
+        // The result will be displayed either in the Symfony Profiler or in the stream output.
+        // See https://symfony.com/doc/current/profiler.html
+        // See https://symfony.com/doc/current/templates.html#the-dump-twig-utilities
 
         return $this->render('blog/post_show.html.twig', ['post' => $post]);
     }

src/Security/PostVoter.php

@@ -37,7 +37,7 @@ class PostVoter extends Voter
      */
     protected function supports(string $attribute, $subject): bool
     {
-        // this voter is only executed for three specific permissions on Post objects
+        // this voter is only executed on Post objects and for three specific permissions
         return $subject instanceof Post && \in_array($attribute, [self::SHOW, self::EDIT, self::DELETE], true);
     }
 

src/Utils/Validator.php

@@ -17,6 +17,7 @@
 /**
  * This class is used to provide an example of integrating simple classes as
  * services into a Symfony application.
+ * See https://symfony.com/doc/current/service_container.html#creating-configuring-services-in-the-container
  *
  * @author Javier Eguiluz <[email protected]>
  */