[java-/phpdoc] Comments bij een interface en implementatie

[Michali]

Ik heb even een vraagje over hoe je goed omgaat met java- en/of phpdoc. Ik ben er nu eigenlijk pas eens serieus naar aan het kijken en stuit even op een probleempje. Het probleem is dat ik een interface en een implementatie ervan heb. Hoe doen jullie dat dan met documenteren? Logisch is natuurlijk dat de interfaces sowieso comments krijgen, maar herhaal je dat dan bij de class die hem implementeerd of laat je dat puur bij de interface?

Zelf lijkt me dat je dat dan niet doet. Misschien als je geforceerd bent om extra functionaliteit achter de functie te stoppen die niet beschreven wordt in de comments van de definitie in de interface, dat je dan dat wel neerzet. Wat ik dus wil weten is wat hierbij een beetje de normale manier van werken is.

[ Voor 5% gewijzigd door Michali op 09-01-2006 17:22 ]

[chris]

Ik heb zelf geen idee, maar het lijkt me dat je redundantie ook in je documentatie wil voorkomen. Geen documentatie-duplicatie. Als je op een gegeven moment besluit iets te veranderen, moet je dat op meer dan een plaats veranderen, en dat is niet ideaal.

Volgens mij genereert javadoc ook meteen linkjes naar de superclasses/geimplementeerde interfaces, dus dan hoef je het ook niet te dupliceren. In sommige gevallen wel natuurlijk, maar volgens mij doe je zoiets gewoon op inzicht.

[jAnO!]

Is in java gewoon een tagje voor:

{@inheritDoc}