I learned about code documentation today with javadoc today and spent the day implementing it (as a upcoming gitlab pages project using GitLab CI/CD -> is not yet public).
javadoc is a java commandline tool shipped with e.g. openjdk.
While doing that I realised that with changing the comment style for multiline comments from:
/*
* Lorem Ipsum ...
*
*/
to
/**
* Lorem Ipsum ...
*
*/
we also change to the javadoc comment-style and the comments get integrated in the generated html pages.
I also removed a typo in Astronomy.java that I discovered while reading the generated test data.
**TL;DR** `/*` -> `/**`
Hi 👋
this is a rather small change in terms of [SLOC](https://en.wikipedia.org/wiki/Source_lines_of_code).
I learned about code documentation today with [javadoc](https://en.wikipedia.org/wiki/Javadoc) today and spent the day implementing it (as a upcoming gitlab pages project using GitLab CI/CD -> is not yet public).
`javadoc` is a java commandline tool shipped with e.g. `openjdk`.
While doing that I realised that with changing the comment style for multiline comments from:
```
/*
* Lorem Ipsum ...
*
*/
```
to
```
/**
* Lorem Ipsum ...
*
*/
```
we also change to the [`javadoc`](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html) comment-style and the comments get integrated in the generated html pages.
I also removed a typo in [`Astronomy.java`](https://codeberg.org/Starfish/TinyWeatherForecastGermany/src/branch/master/app/src/main/java/org/astronomie/info/Astronomy.java#L477) that I discovered while reading the generated test data.
The named GitLab project is also capable of mirroring the codeberg repo to GitLab and GitHub.
I'd like to share the details with @Starfish upfront to a possible public release in the next weeks.
The named GitLab project is also capable of mirroring the codeberg repo to GitLab and GitHub.
I'd like to share the details with @Starfish upfront to a possible public release in the next weeks.
for further examples concerning the use of `javadoc` please see the comments in [`Astronomy.java`](https://codeberg.org/Starfish/TinyWeatherForecastGermany/src/branch/master/app/src/main/java/org/astronomie/info/Astronomy.java)
This wikipedia [table](https://en.wikipedia.org/wiki/Javadoc#Table_of_Javadoc_tags) might also be helpful.
I wasn't aware that license info should be Javadoc too. :-)
well fair point :-)
Just thought it might be better to streamline the comment-style. But you're right from the javadoc scope there's no real added value at this time
@Starfish
>I wasn't aware that license info should be Javadoc too. :-)
well fair point :-)
Just thought it might be better to streamline the comment-style. But you're right from the javadoc scope there's no real added value at this time
TL;DR
/*->/**Hi 👋
this is a rather small change in terms of SLOC.
I learned about code documentation today with javadoc today and spent the day implementing it (as a upcoming gitlab pages project using GitLab CI/CD -> is not yet public).
javadocis a java commandline tool shipped with e.g.openjdk.While doing that I realised that with changing the comment style for multiline comments from:
to
we also change to the
javadoccomment-style and the comments get integrated in the generated html pages.I also removed a typo in
Astronomy.javathat I discovered while reading the generated test data.The named GitLab project is also capable of mirroring the codeberg repo to GitLab and GitHub.
I'd like to share the details with @Starfish upfront to a possible public release in the next weeks.
for further examples concerning the use of
javadocplease see the comments inAstronomy.javaThis wikipedia table might also be helpful.
1477f8c5c4into master 2 years agoI wasn't aware that license info should be Javadoc too. :-)
@Starfish
well fair point :-)
Just thought it might be better to streamline the comment-style. But you're right from the javadoc scope there's no real added value at this time
1477f8c5c4.