undefined | Better HN

0 pointsYaina4y ago0 comments

I mean rust supports markdown comments and can compile them into documentation.[1] That's pretty good in my book in terms of documentation.

[1]https://doc.rust-lang.org/rust-by-example/meta/doc.html

0 comments

k__4y ago

I wouldn't call it good. But better than nothing, I guess.

YainaOP4y ago

I think it's as good as it gets. The rough principal is there: You have one file, and you can derive the documentation and the program from it with different compilers.

The idea of reading code like a book seems extremely flawed to me, and any attempts to create such languages either look like regular source code with slightly different syntax or are barely comprehensible (e.g. TeX)

db48x4y ago

Have you actually read TeX: The Book? It is far from “extremely flawed”.

2 more replies

k__4y ago

I liked the idea of literate CoffeeScript.

It was basically Markdown and when executed, all but the code blocks was removed.

Made for a pretty nice file structure.

j / k navigate · click thread line to collapse

0 pointsYaina4y ago0 comments

I mean rust supports markdown comments and can compile them into documentation.[1] That's pretty good in my book in terms of documentation.

[1]https://doc.rust-lang.org/rust-by-example/meta/doc.html

0 comments

k__4y ago

I wouldn't call it good. But better than nothing, I guess.

YainaOP4y ago

I think it's as good as it gets. The rough principal is there: You have one file, and you can derive the documentation and the program from it with different compilers.

db48x4y ago

Have you actually read TeX: The Book? It is far from “extremely flawed”.

2 more replies

k__4y ago

I liked the idea of literate CoffeeScript.

It was basically Markdown and when executed, all but the code blocks was removed.

Made for a pretty nice file structure.

j / k navigate · click thread line to collapse