Om docblock

[mosbth]

Någon mer än jag som har svårt att förstå phpstan och/eller docstrings för php? Har jag missat någon föreläsning om hur vi gör doc-strings för php ? Finnns det ? Jag läser på hemsidan phpstan.org men förstår inte hur jag kan implemetera det i min kod och på vilka ställen.

Njae, jag har inte fokuserat på kommentarer enligt php docblock i år. Jag gjorde det tidigare år och tom krävde att det skulle finnas. I kmom04 finns med en del där man installerar phpdoc som är ett verktyg som kan generera dokumentation från koden till en webbplats. Så där kommer lite mer om dockblock kommentarer.

Den dokumentation som finns (för att skriva dockblock kommentarer) är nog bäst i verktyget phpdocumentor: https://docs.phpdoc.org/3.0/

Rent generellt är dockblock kommentarer något som finns i de flesta programmingsspråk och syftet är att bättre förklara detaljer i koden samt skapa ett underlag som gör det möjilgt att generera dokumentation. https://en.wikipedia.org/wiki/Docblock

En liten dockblock som ger en oneliner om vad metoden gör.

<?php
/**
 * This is a DocBlock.
 */
function associatedFunction()
{
}

En större dockblock med fler detaljer.

<?php
/**
 * A summary informing the user what the associated element does.
 *
 * A *description*, that can span multiple lines, to go _in-depth_ into
 * the details of this element and to provide some background information
 * or textual references.
 *
 * @param string $myArgument With a *description* of this argument,
 *                           these may also span multiple lines.
 *
 * @return void
 */
 function myFunction($myArgument)
 {
 }