Discussion:
[Cucumber] [java] how to generate documentation for step definitation(java) and featre files
(too old to reply)
DEEPAK KUMAR
2017-10-13 08:11:02 UTC
Permalink
Raw Message
Hi Guys,

I am using cucumber, gherkin and feature file to written test cases using
java.
I am looking to generate documentation(may be in html ) from java (steps
definition) and feature files like yard cucumber (
http://burtlo.github.io/yard-cucumber/requirements.html). This is written
in ruby and generate document after scanning ruby and feature files. Can we
use yard-cucumber to scan java files?

Can you guys please help me?

Thanks in advance..
--
Posting rules: http://cukes.info/posting-rules.html
---
You received this message because you are subscribed to the Google Groups "Cukes" group.
To unsubscribe from this group and stop receiving emails from it, send an email to cukes+***@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Andrew Premdas
2017-10-13 08:37:17 UTC
Permalink
Raw Message
Cucumber features are documentation (amongst other things) so generating
documentation for them statically seems an odd thing to do. Cucumber is
designed so that when you run the scenarios the output is documentation,
you can get this in the format you need by using one of the various
formatters that come with cucumber (or writing your own). Steo definitions
are code, so you can use normal code documentation tools on them. However
there are some things you should be aware of

1. If you step definitions need documentation they are probably to complex
and should be simplified
2. Step definition code tends to have a high rate of churn, so you might
end up spending alot of time fixing your documentation to keep things in
sync.

HTH

Andrew
Post by DEEPAK KUMAR
Hi Guys,
I am using cucumber, gherkin and feature file to written test cases using
java.
I am looking to generate documentation(may be in html ) from java (steps
definition) and feature files like yard cucumber (
http://burtlo.github.io/yard-cucumber/requirements.html). This is written
in ruby and generate document after scanning ruby and feature files. Can we
use yard-cucumber to scan java files?
Can you guys please help me?
Thanks in advance..
--
Posting rules: http://cukes.info/posting-rules.html
---
You received this message because you are subscribed to the Google Groups "Cukes" group.
To unsubscribe from this group and stop receiving emails from it, send an
For more options, visit https://groups.google.com/d/optout.
--
------------------------
Andrew Premdas
blog.andrew.premdas.org
--
Posting rules: http://cukes.info/posting-rules.html
---
You received this message because you are subscribed to the Google Groups "Cukes" group.
To unsubscribe from this group and stop receiving emails from it, send an email to cukes+***@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Loading...