From f64e080d9abe4e7b1c59d99fc7df2cfdcbb8320e Mon Sep 17 00:00:00 2001
From: Garrett Berg <googberg@gmail.com>
Date: Fri, 12 Jun 2015 20:49:01 -0600
Subject: [PATCH] CODECONVENTIONS.md: add documentation on putting comments in
 code.

---
 CODECONVENTIONS.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/CODECONVENTIONS.md b/CODECONVENTIONS.md
index 9d5f6d0cca..ac04379be5 100644
--- a/CODECONVENTIONS.md
+++ b/CODECONVENTIONS.md
@@ -52,13 +52,19 @@ general guidelines are:
 - You can use int/uint, but remember that they may be 16-bits wide.
 - If in doubt, use mp_int_t/mp_uint_t.
 
+Comments:
+- Be concise and only write comments for things that are not obvious.
+- Use `// ` prefix, NOT `/* ... */`. No extra fluff.
+
 Examples
 --------
 
-Braces, spaces and names:
+Braces, spaces, names and comments:
 
     #define TO_ADD (123)
 
+    // This function will always recurse indefinitely and is only used to show
+    // coding style
     int foo_function(int x, int some_value) {
         if (x < some_value) {
             foo(some_value, x);