@api en @internal in PHPDoc

Overzicht Reageren

Sponsored by: Vacatures door Monsterboard

Web Ontwikkelaar PHP, Nijmegen

Contactpersoon Roel Kavelaar rkavelaarATsearch-consult.nl 0243528815 0644949337 Organisatie Jong, gezond en sterk groeiende bedrijf dat webbased multimedia oplossingen bouwt in de omgeving Nijmegen. Het bedrijf bouwt voor klanten o.a. geavanceerde websites, webwinkels, webapplicaties en specifieke webbased software. Het bedrijf ontwikkelt en onderhoudt ook verschillende bekende Nederlandse websites. Op dit moment hebben zij een groeiende en brede klantenkring opgebouwd. Met betrekking tot programmeer-, onderhoud-, ontwerp-werkzaamheden wordt een PHP ontwikkelaar gezocht met kennis van contentmanagementsysteemen en frameworks. Locatie Nijmegen Verantwoordelijkheden (Her)Ontwerpen en (her)ontwikkelen in PHP ten behoeve van websites voor klanten, project klussen, onderhoud en specifieke klantwensen (Her)Ontwerpen en (her)ontwikkelen in PHP, PHP

Bekijk vacature »

Ward van der Put
Moderator

Ward van der Put

20/04/2016 11:12:22
Quote Anchor link
Vaak gebruik ik in PHPDoc de tag @api en de tegenhanger @internal, bijvoorbeeld:

Code (php)
PHP script in nieuw venster Selecteer het PHP script
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?php
/**
 * @api
 * @param void
 * @return bool
 */

public function isFoo()
{

    // ...
}

/**
 * @internal
 * @param string $bar
 * @return void
 */

private function setBar($bar)
{

    // ...
}
?>


Bij nader inzien is dat echter misschien onzinnig: API versus interne methode komt immers al tot uitdrukking in public (@api) versus private (@internal). Hoe kijken jullie hier tegenaan?
 
PHP hulp

PHP hulp

22/02/2019 14:43:16
 
Wouter J

Wouter J

20/04/2016 12:55:04
Quote Anchor link
Ik zou 1 van de 2 gebruiken. Symfony heeft voor @internal gekozen ipv @api.

Deze annotations hebben niet heel veel zin op method niveau, meer op class niveau. Op method niveau kun je dit inderdaad al aan de visibility zien. Maar er zijn bijvoorbeeld ook classes die iedereen kan gebruiken, maar die als internal beschouwd moeten worden (denk bijv. aan XmlUtils die Symfony gebruikt voor het parsen van XML bestanden).
 
Ward van der Put
Moderator

Ward van der Put

20/04/2016 13:09:48
Quote Anchor link
Mooi antwoord Wouter, dank je!
 



Overzicht Reageren

 
 

Om de gebruiksvriendelijkheid van onze website en diensten te optimaliseren maken wij gebruik van cookies. Deze cookies gebruiken wij voor functionaliteiten, analytische gegevens en marketing doeleinden. U vindt meer informatie in onze privacy statement.