Avoiding duplication in JavaDoc comments
Posted
by
TERACytE
on Stack Overflow
See other posts from Stack Overflow
or by TERACytE
Published on 2011-01-14T20:50:34Z
Indexed on
2011/01/14
20:53 UTC
Read the original article
Hit count: 247
I am writing a class where the same xml is used between some methods.
e.g.
/**
* Sample Response:
* <xmp>
* <myXML>
* <stuff> data </stuff>
* </myXML>
* </xmp>
*/
CommonXML Method1();
/**
* Sample Submission:
* <xmp>
* <myXML>
* <stuff> data </stuff>
* </myXML>
* </xmp>
*/
void Method2(CommonXML xml);
I would like to write my documentation so that if the xml changes I have one resource to modify, rather than updating all of the JavaDoc for the affected methods.
Does anyone know how to accomplish this?
© Stack Overflow or respective owner