diff options
Diffstat (limited to 'reference/C/CONTRIB/SNIP/style.c')
| -rwxr-xr-x | reference/C/CONTRIB/SNIP/style.c | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/reference/C/CONTRIB/SNIP/style.c b/reference/C/CONTRIB/SNIP/style.c new file mode 100755 index 0000000..d25c111 --- /dev/null +++ b/reference/C/CONTRIB/SNIP/style.c @@ -0,0 +1,32 @@ +/***************************************************************************/
+/* Global (public) headers look like this */
+/* */
+/* foo() */
+/* Parameters: description of each passed datum */
+/* Returns: description of return value & significance */
+/* Side effects: complete details */
+/* Notes: extra info */
+/***************************************************************************/
+
+/*
+** Static (local) headers look like this
+**
+** Brief description
+*/
+
+int foo(void) /* use ANSI prototypes on every compiler that supports 'em */
+{
+ int local1, local2; /* local variable declarations are always
+ followed by a blank line */
+
+ do_stuff();
+ if (bar(local1))
+ { /* long comments here *//* this lines up with -----------+ */
+ char *local3; /* autos declared close to use | */
+ /* | */
+ do_more_stuff(); /* (everything else indented) | */
+ local2 = strlen(local3);/* | */
+ } /* this <------------------------+ */
+ else local2 = fubar(); /* using tab >= 6, else's line up */
+ return local2;
+} /* no question where functions end! */
|