search

quick-perf / quickperf

QuickPerf is a testing library for Java to quickly evaluate and improve some performance-related properties
https://github.com/quick-perf/doc/wiki/QuickPerf
Apache License 2.0
488 stars 65 forks source link

Add Javadoc to core annotations #88

Closed jeanbisutti closed 4 years ago

jeanbisutti commented 4 years ago

core annotations are documented in QuickPerf wiki .

The goal of this issue is to add Javadoc to core annotations that are located in core Maven module.

The documention contained in QuickPerf wiki can be used to add Javadoc to the core annotations. Don't hesitate to improve it.

FTarfasse commented 4 years ago

Hi Jean,

I would like to work on this please.

Question: can you precise me the difference between @FunctionalIteration and @DisableQuickPerf please (except the fact we can add a comment on one of the two) ? The Runner classes seems to consider them equally (they both completely disable annotations) but I feel I am missing something ...

Thanks,

Kind regards, Fabrice

jeanbisutti commented 4 years ago

Hi Fabrice,

Great! I assign this issue to you.

Question: can you precise me the difference between @FunctionalIteration and @DisableQuickPerf please (except the fact we can add a comment on one of the two) ? The Runner classes seems to consider them equally (they both completely disable annotations) but I feel I am missing something ...

@FunctionalIteration and @DisableQuickPerf have the same behavior. They disable QuickPerf.

During a feature implementation, @FunctionalIteration is more explicit than @DisableQuickPerf about focusing on functional behavior (not performance behavior) in a first step. Without @FunctionalIteration or @DisableQuickPerf, the test may fail because of global performance annotation even if the functional behavior is ok. In a second implementation step, you can remove @FunctionalIteration to evaluate some performance properties.

We recommend to do one step at a time: we implement the functional behavior and after we focus on some performance characteristics.

Kind regards,

Jean

FTarfasse commented 4 years ago

Hello Jean,

I re-submitted a PR with your feedbacks. I tweaked a bit your proposal for @FunctionalIteration.

Let me know your opinion !

Kind regards, Fabrice

jeanbisutti commented 4 years ago

Hello Fabrice,

That's great! Many thanks Fabrice!!!

Thank you a lot for all your contributions.

Kind regards,

Jean

jeanbisutti commented 4 years ago

Fixed with a3855ed6a292302fc3bc3de7db376565b414631c

FTarfasse commented 4 years ago

As always, happy to help !