It's along the lines that we follow. Declaring the public functions first however forces you to use a declare statement for all the private functions used by your public API.
We use section comments to split the module (constants, global defs, private functions, public ones, ...) and keep the public API at the bottom. If you search for the public API section you get directly at the public API of the module. As for the coding style, we are not maniacs, later we intend to run the code in a formater to standardize. We use LISP style naming conventions (hyphens in names, +constant+. *global-var*,...) Luc On Sun, 2009-08-09 at 17:47 +0100, Lauri Pesonen wrote: > 2009/8/8 Luc Prefontaine <lprefonta...@softaddicts.ca>: > > > I totally agree no comments is not good at all but JavaDoc style comments in > > Clojure ? I pray you all, please stay away of it :)))) > > I was quite taken by this scheme style guide recently: > > http://mumble.net/~campbell/scheme/style.txt > > While I don't agree with all the points in it, and some advice is not > Clojure compatible (e.g. "do not use square brackets" and the > CL-specific block comments), I think that the guide gave me a to think > about. Something that I hadn't come across before was the use of page > breaks in source code. I also like the style of documenting a module > and all of it's public functions in the beginning of a file which then > allows the user to avoid the temptation of reading the source code > unless absolutely necessary. Also, have a look at the scheme skip list > implementation which follows the style guide: > > http://mumble.net/~campbell/scheme/skip-list.scm > > > Luc > Luc Préfontaine Armageddon was yesterday, today we have a real problem... --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en -~----------~----~----~----~------~----~------~--~---
