Skip to content

Instantly share code, notes, and snippets.

@humorless

humorless/how-to-write-comments.md

Last active June 2, 2021 08:39
Show Gist options
  • Save humorless/2be31932cddb4b5a2f5147f5c87dc933 to your computer and use it in GitHub Desktop.
Save humorless/2be31932cddb4b5a2f5147f5c87dc933 to your computer and use it in GitHub Desktop.
Download ZIP
Some Clojure ideas
Raw
how-to-write-comments.md

There are three important comments:

  1. Horizonal comments
  2. doc string comment
  3. FIXME

Horizontal comments

Horizonal comment splits a namespace into sub sections

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Connection

doc string comments

doc string comments are especially important for the APIs of a module.

FIXME

When you have no time, you write something totally a work around. Add a FIXME comment.

Raw
note.clj
cond
cond->
defprotocol
defrecord
update
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment