APF-Tracker

Adventure PHP Framework Issue Management


View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0000210Adventure PHP FrameworkDokumentation // Documentationpublic2014-06-19 00:342016-08-10 14:20
Reporterdingsda 
Assigned To 
PrioritynormalSeveritytweakReproducibilityN/A
StatusnewResolutionopen 
Product Version2.1 
Target Version3.4Fixed in Version 
Summary0000210: Einführung von @inheritdoc in phpDocBlocks
DescriptionAktuell sind bei abgeleiteten Klassen oder Klassen, die ein interface implementieren oft nochmal die DocBlocks für die Methoden zu finden, die ähnlichen Wortlaut haben oder eine exakte kopie des DocBlocks der Methode im interface/parent.

Durch den DocBlock in den abgeleiteten klassen entsteht die Notwendigkeit, diesen auch mitanzupassen, wenn sich die Beschreibung im Interface/parent ändert.

Eine erneute Dokumentation dieser Methoden ist nicht nötig, da IDEs und Doxygen die Doku auch so finden und anzeigen.

Den DocBlock ganz wegzulassen, kann aber verwirrend sein, weil nicht sofort ersichtlich ist, ob der nicht einfach nur vergessen wurde. aus dem grund ist die nutzung des tags @inheritdoc vorzuziehen.
Der tag wird zwar eigentlich nur ignoriert von der IDE aber ist wie gesagt beim stöbern im code besser als die Methode ohne DocBlock zu lassen.

Im laufe der Entwicklung für 2.2 sollten schrittweise unnötige doppeldokumentationen entfernt werden.
TagsNo tags attached.
Codereferenz: ([Datei]:[Zeile])
Namespacenone
Attached Files

- Relationships
related to 0000209closedChristianAchatz Unnötige PhpDoc Tags entfernen 

-  Notes
(0000393)
ChristianAchatz (administrator)
2014-06-20 12:14

Guter Punkt! +1
(0000417)
dingsda (developer)
2014-06-29 13:00

neue infos dazu:
http://forum.adventure-php-framework.org/viewtopic.php?f=7&t=923&start=15#p19408 [^]

ganz unten gehts um geerbte docblocks bei überschreiben von methoden. kurzfassung:
 - phpstorm und doxygen unterstützen dies sowohl mit als auch ohne @inheritdoc.
 - netbeans unterstützt es nie
(0000418)
ChristianAchatz (administrator)
2014-06-29 13:56

Vielen Dank für deine Recherche! :) Kommentare siehe Post.
(0000594)
ChristianAchatz (administrator)
2015-09-05 17:06

Moved to 3.2 to shape scope for 3.1.

- Issue History
Date Modified Username Field Change
2014-06-19 00:34 dingsda New Issue
2014-06-20 12:14 ChristianAchatz Note Added: 0000393
2014-06-29 13:00 dingsda Note Added: 0000417
2014-06-29 13:56 ChristianAchatz Note Added: 0000418
2014-06-29 13:57 ChristianAchatz Relationship added related to 0000209
2015-01-28 19:14 ChristianAchatz Target Version 3.0 => 3.1
2015-09-05 17:06 ChristianAchatz Note Added: 0000594
2015-09-05 17:06 ChristianAchatz Target Version 3.1 => 3.2
2016-03-23 14:01 ChristianAchatz Target Version 3.2 => 3.3
2016-08-10 14:20 ChristianAchatz Target Version 3.3 => 3.4


Copyright © 2000 - 2017 MantisBT Team
Powered by Mantis Bugtracker