I wrote an article about how Apache Commons Lang could use Java::Geci to
keep JavaDoc up to date. It will be published on Wednesday 16:00CEST time
on https://javax0.wordpress.com I copy the text of the article here so that
you can read before it is published and also if you have any comment before
Response inline
On Wed, Aug 28, 2019 at 11:55 PM Peter Verhas wrote:
>
> [snip...]
> Paul King
>
> >You can stop using the JavadocAssertionTestSuite at any time.
> >The code will still be in the Javadoc as documentation but just won't
> >be tested any more as part of your test suite.
>
> This
>Runtime retention is a potential problem, as an extra binary may be needed.
>The jar might no longer be a drop-in replacement.
That is exactly while the annotations are an option only to use.
On Wed, Aug 28, 2019 at 4:17 PM sebb wrote:
> On Wed, 28 Aug 2019 at 14:55, Peter Verhas wrote:
> >
>
On Wed, 28 Aug 2019 at 14:55, Peter Verhas wrote:
>
> Bruno P. Kinoshita>But if you could perhaps show the pros and cons,
>
> There is a slight overhead marking and naming the code snippets and also
> the code segments where the snippets should be inserted. It is slightly
> more complex than just
Bruno P. Kinoshita>But if you could perhaps show the pros and cons,
There is a slight overhead marking and naming the code snippets and also
the code segments where the snippets should be inserted. It is slightly
more complex than just copy-paste but not a big deal. If the unit test
lines are not
I haven't used Geci, so can't really comment on all the things it
might be capable of.
With respect to something equivalent to Python doctests, in the Groovy
project we
have JavadocAssertionTestBuilder and JavadocAssertionTestSuite classes.
Feel free to look to those for inspiration (at least).
F
: dev@commons.apache.org
主题: [LANG] Q: introduction of new development tool
I have seen looking over the code of the LANG3 project that there are a lot
of places where the code is copy/paste. Many times these copy/paste code is
the result of the shortages of the Java language. We implement methods
In Python doctests are handy, where you can write documentation with code
blocks, that can be executed with a unit-test running tool, validating the docs.
It's the first time I heard about Geci. But if you could perhaps show the pros
and cons, what is the maintenance involved, whether it would c
There is such a thing we used to call 'code slurping' where when I
co-authored "Java Persistence with Hibernate Second Edition" [1], we
automatically compiled, ran, and slurped in Java code into the XHTML source
for the book using https://github.com/4thline/lemma, meaning zero Java
code duplicatio
The idea of automatically using unit tests as code samples in the
documentation sounds great! This sounds fairly interesting to me.
On Tue, Aug 27, 2019 at 08:00, Peter Verhas wrote:
> I have seen looking over the code of the LANG3 project that there are a lot
> of places where the code is copy/
I have seen looking over the code of the LANG3 project that there are a lot
of places where the code is copy/paste. Many times these copy/paste code is
the result of the shortages of the Java language. We implement methods that
look more or less the same but they have to be created for all primitiv
11 matches
Mail list logo
