Skip to content

Write JavaDoc the right way #248

@FanJups

Description

@FanJups

Great advice from Ken Fogel

https://twitter.com/omniprof/status/1672328157926391809?t=upNMd6j1_ieYJiEh_HRcww&s=19

For once & for all, JavaDocs for an API without code samples for each & every method, interface, class, etc. is an abomination. When I read documentation that refers me to the API's JavaDocs I know I am in for a disappointment.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationinformationgood to knowjsgeneratorRelated to the whole Project

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions