search

inventid / tails

Models on the fly!
MIT License
1 stars 0 forks source link

Literate CoffeeScript #28

Closed steffansluis closed 10 years ago

steffansluis commented 10 years ago

We should think about converting our codebase to Literate CoffeeScript while we are working on them. The process is painless to do for one file and it produces a cleaner source in the end, with the possibility to generate documentation very easily, since the source code is the documentation and vice versa. The grunt plugin we use already supports it, so I don't think we need any config changes. We only need to start writing Literate CoffeeScript. @joostverdoorn @rogierslag Are you in favor?

rogierslag commented 10 years ago

I think this would be really cool, especially with the relation between comments and code in one file. I don't have any experience with it though, so I'm also curious what @joostverdoorn thinks about it

steffansluis commented 10 years ago

Joost and I have spoken about this and agreed it would probably not be too hard to write a crude parser from CoffeeScript to Literate CoffeeScript. We can therefore convert our codebase easily, making this issue somewhat less pressing and automatable. I think we should close this issue for now and focus on producing good documentation (preferably with coverage) rather than the documentation style.