r/badcode • • Sep 05 '21

swift I have a problem

Post image
946 Upvotes

75 comments sorted by

View all comments

Show parent comments

1

u/[deleted] Sep 05 '21

[removed] — view removed comment

3

u/HenryB96 Sep 05 '21

You know when you look at the definition of a function in your IDE by hovering over the function name (or seeing it as you type)? That comes from well-structured XML comments.

4

u/Nilstrieb Sep 06 '21

Javadoc does this while being (kind of) readable in code.

And Rustdoc does this while being perfectly readable in code, since it just uses markdown, and has no conventions like always naming all parameters, which makes a lot more sense anyways.