0

Recently I have collected lots of api examples for java api(jdk,log4j,etc.), but I've got a problem about inserting the code example into the project's javadoc. People usually use the javadoc and doclet tools to do this, it seems that the source code of the projects maybe changed. For example an example , if I want to add an example to Button, then I may have to add an @example tag in the comment of the Button class...

Is there any tool or way can help me to solve this? to generate javadoc with a lot of collected examples from the Internet,without changing the source code too much~ Thanks a lot!

Improve this question

1 Answer 1

Reset to default
0

I find this article . It related to your question. But I agree with Michael Barth. So, why would you want to put commented source code into a comment? Сomments and source code should complement each other.

Improve this answer
Sign up to request clarification or add additional context in comments.

1 Comment

Thanks for you advice~ but I just want to insert code example into javadoc, not the source code, Is there any automatic way to solve this problem(I have collected quite a lot examples)

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.