c30f8dbcd32fe5d6dc9a0b4c26b02b5c7acdd997
[privoxy.git] / doc / STANDARDS.txt
1 @ Introduction
2
3
4 This set of standards is designed to make our lives easier. It is
5 developed with the simple goal of helping us keep the "new and
6 improved Junkbusters" consistent and reliable.  Thus making
7 maintenance easier and increasing chances of success of the
8 project.
9
10 And that of course comes back to us as individuals. If we can
11 increase our development and product efficiencies then we can
12 solve more of the request for changes/improvements and in general 
13 feel good about ourselves.  ;->
14
15
16 @ Using Comments
17
18
19 @@ Comment, Comment, Comment
20
21 @@@ Explanation:
22
23 Comment as much as possible without commenting the obvious.  For
24 example do not comment "aVariable is equal to bVariable".  Instead
25 explain why aVariable should be equal to the bVariable.  Just
26 because a person can read code does not mean they will understand
27 why or what is being done.  A reader may spend a lot more time
28 figuring out what is going on when a simple comment or explanation
29 would have prevented the extra research.  Please help your brother
30 IJB'ers out!
31
32 The comments will also help justify the intent of the code.  If the
33 comment describes something different than what the code is doing
34 then maybe a programming error is occurring.
35
36 @@@ Example:
37
38 /* if page size greater than 1k ... */
39 if ( PageLength() > 1024 )
40 {
41     ... "block" the page up ...
42 }
43
44 /* if page size is small, send it in blocks */
45 if ( PageLength() > 1024 )
46 {
47     ... "block" the page up ...
48 }
49
50 This demonstrates 2 cases of "what not to do".  The first is a
51 "syntax comment".  The second is a comment that does not fit what
52 is actually being done.
53
54
55 @@ Use blocks for comments
56
57 @@@ Explanation:
58
59 Comments can help or they can clutter.  They help when they are
60 differentiated from the code they describe.  One line comments do
61 not offer effective separation between the comment and the code.
62 Block identifiers do, by surrounding the code with a clear,
63 definable pattern.
64
65 @@@ Example:
66
67 /*********************************************************************
68  * This will stand out clearly in your code!
69  *********************************************************************/
70 if ( thisVariable == thatVariable )
71 {
72    DoSomethingVeryImportant();
73 }
74
75
76 /* unfortunately, this may not */
77 if ( thisVariable == thatVariable )
78 {
79    DoSomethingVeryImportant();
80 }
81
82
83 if ( thisVariable == thatVariable ) /* this may not either */
84 {
85    DoSomethingVeryImportant();
86 }
87
88 @@@ Exception:
89
90 If you are trying to add a small logic comment and do not wish to
91 "disrubt" the flow of the code, feel free to use a 1 line comment
92 which is NOT on the same line as the code.
93
94
95 @@ Keep Comments on their own line
96
97 @@@ Explanation:
98
99 It goes back to the question of readability.  If the comment is on
100 the same line as the code it will be harder to read than the
101 comment that is on its own line.
102
103 There are three exceptions to this rule, which should be violated
104 freely and often: during the definition of variables, at the end
105 of closing braces, when used to comment parameters.
106
107 @@@ Example:
108
109 /*********************************************************************
110  * This will stand out clearly in your code,
111  * But the second example won't.
112  *********************************************************************/
113 if ( thisVariable == thatVariable )
114 {
115    DoSomethingVeryImportant();
116 }
117
118 if ( thisVariable == thatVariable ) /*can you see me?*/
119 {
120    DoSomethingVeryImportant(); /*not easily*/
121 }
122
123
124 /*********************************************************************
125  * But, the encouraged exceptions:
126  *********************************************************************/
127 int urls_read     = 0;     /* # of urls read + rejected */
128 int urls_rejected = 0;     /* # of urls rejected */
129
130 if ( 1 == X )
131 {
132    DoSomethingVeryImportant();
133 }
134
135
136 short DoSomethingVeryImportant(
137    short firstParam,   /* represents something */
138    short nextParam     /* represents something else */ )
139 {
140    ...code here...
141
142 }   /* -END- DoSomethingVeryImportant */
143
144
145 @@ Comment each logical step
146
147 @@@ Explanation:
148
149 Logical steps should be commented to help others follow the
150 intent of the written code and comments will make the code more
151 readable.
152
153 If you have 25 lines of code without a comment, you should
154 probably go back into it to see where you forgot to put one.
155
156 Most "for", "while", "do", etc... loops _probably_ need a
157 comment.  After all, these are usually major logic containers.
158
159
160 @@ Comment All Functions Thoroughly
161
162 @@@ Explanation:
163
164 A reader of the code should be able to look at the comments just
165 prior to the beginning of a function and discern the reason for
166 its existence and the consequences of using it.  The reader
167 should not have to read through the code to determine if a given
168 function is safe for a desired use.  The proper information
169 thoroughly presented at the introduction of a function not only
170 saves time for subsequent maintenance or debugging, it more
171 importantly aids in code reuse by allowing a user to determine
172 the safety and applicability of any function for the problem at
173 hand.  As a result of such benefits, all functions should contain
174 the information presented in the addendum section of this
175 document.
176
177
178 @@ Comment at the end of braces if the content is more than one screen length
179
180 @@@ Explanation:
181
182 Each closing brace should be followed on the same line by a
183 comment that describes the origination of the brace if the
184 original brace is off of the screen, or otherwise far away from
185 the closing brace.  This will simplify the debugging, maintenance,
186 and readability of the code.
187
188 As a suggestion , use the following flags to make the comment and
189 its brace more readable:
190
191 use following a closing brace:
192    } /* -END- if() or while () or etc... */
193
194 @@@ Example:
195
196 if ( 1 == X )
197 {
198    DoSomethingVeryImportant();
199    ...some long list of commands...
200 } /* -END- if x is 1 */
201
202 or:
203
204 if ( 1 == X )
205 {
206    DoSomethingVeryImportant();
207    ...some long list of commands...
208 } /* -END- if ( 1 == X ) */
209
210
211 @ Naming Conventions
212
213
214 @@ Variable Names
215
216 @@@ Explanation:
217
218 Seperate words via an underscore ('_').
219
220 @@@ Example:
221
222 int ms_iis5_hack = 0;
223
224 @@@ Instead of:
225
226 int msiis5hack = 0;
227 int msIis5Hack = 0;
228
229
230 @@ Function Names
231
232 @@@ Explanation:
233
234 Seperate words via an underscore ('_').
235
236 @@@ Example:
237
238 int load_aclfile( struct client_state *csp )
239
240 @@@ Instead of:
241
242 int loadaclfile( struct client_state *csp )
243 int loadAclFile( struct client_state *csp )
244
245
246 @@ Header file prototypes
247
248 @@@ Explanation:
249
250 Use a descriptive parameter name in the function prototype in
251 header files.  Use the same parameter name in the header file
252 that you use in the c file.
253
254 @@@ Example:
255
256 (.h) extern int load_aclfile( struct client_state *csp );
257 (.c) int load_aclfile( struct client_state *csp )
258
259 @@@ Instead of:
260 (.h) extern int load_aclfile( struct client_state * );   or
261 (.h) extern int load_aclfile();
262 (.c) int load_aclfile( struct client_state *csp )
263
264
265 18.  Ennumerations, and #defines
266
267 @@@ Explanation:
268
269 Use all capital letters, with underscores between words.
270
271 @@@ Example:
272
273 (enumeration) : enum Boolean { FALSE, TRUE };
274 (#define) : #define DEFAULT_SIZE 100;
275
276 @@@ Note: We should have a standard naming scheme for Symbols that
277 toggle a feature in the precompiler, and the constants used by that
278 feature. I'd propose that the toggles should be just one word, with
279 a common prefix, and that any depandant constants should be
280 prefixed by that word.
281
282 The prefix could be WITH_, HAVE_, ENABLE_, FEATURE_ etc.
283
284 @@@ Status: I see some this in the code currently!  Anybody "figured"
285 out a standard way to do this?
286
287 @@@ Example:
288
289 #define ENABLE_FORCE 1
290
291 #ifdef ENABLE_FORCE
292 #define FORCE_PREFIX blah
293 #endif /* def ENABLE_FORCE */
294
295
296 @@ Constants
297
298 @@@ Explanation:
299
300 Spell common words out entirely (do not remove vowels).
301
302 Use only widely-known domain acronyms and abbreviations.  Capitalize
303 all letters of an acronym.
304
305 Use underscore (_) to separate adjacent acronyms and
306 abbreviations.  Never terminate a name with an underscore.
307
308 @@@ Example:
309
310 #define USE_IMAGE_LIST 1
311
312 @@@ Instead of:
313
314 #define USE_IMG_LST 1       or
315 #define _USE_IMAGE_LIST 1   or
316 #define USE_IMAGE_LIST_ 1   or
317 #define use_image_list  1   or
318 #define UseImageList    1
319
320
321 @ Using Space
322
323
324 @@ Put braces on a line by themselves.
325
326 @@@ Explanation:
327
328 The brace needs to be on a line all by itself, not at the end of
329 the statement.  Curly braces should line up with the construct
330 that they're associated with.  This practice makes it easier to
331 identify the opening and closing braces for a block.
332
333 @@@ Example:
334
335 if ( this == that )
336 {
337    ...
338 }
339
340 @@@ Instead of:
341
342 if ( this == that ) {
343    ...
344 }
345
346 or
347
348 if ( this == that ) { ...  }
349
350 @@@ Note: In the special case that the if-statement is inside a loop,
351 and it is trivial, i.e. it tests for a condidtion that is obvious
352 from the purpose of the block, one-liners as above may optically
353 preserve the loop structure and make it easier to read.
354
355 @@@ Status: developer-discrection.
356
357 @@@ Example exception:
358
359 while ( more lines are read )
360 {
361    /* Please document what is/is not a comment line here */
362    if ( it's a comment ) continue;
363
364    do_something( line );
365 }
366
367
368 @@ ALL control statements should have a block
369
370 @@@ Explanation:
371
372 Using braces to make a block will make your code more readable
373 and less prone to error.  All control statements should have a
374 block defined.
375
376 @@@ Example:
377
378 if ( this == that )
379 {
380    DoSomething();
381    DoSomethingElse();
382 }
383
384 @@@ Instead of:
385
386 if ( this == that )
387    DoSomething();
388    DoSomethingElse();
389
390 or
391
392 if ( this == that ) DoSomething();
393
394 @@@ Note: The first example in "Instead of" will execute in a manner
395 other than that which the developer desired (per indentation).  Using
396 code braces would have prevented this "feature".  The "explanation"
397 and "exception" from the point above also applies.
398
399
400 @@ Do not belabor/blow-up boolean expressions
401
402 @@@ Example:
403
404 structure->flag = ( condition );
405
406 @@@ Instead of:
407
408 if ( condition )
409 {
410    structure->flag = 1;
411 }
412 else
413 {
414    structure->flag = 0;
415 }
416
417 @@@ Note: The former is readable and consice.  The later is wordy and
418 inefficient.  Please assume that any developer new to the project has
419 at least a "good" knowledge of C/C++.  (Hope I do not offend by that
420 last comment ... 8-)
421
422
423 @@ Use white space freely because it is free
424
425 @@@ Explanation:
426
427 Make it readable.  The notable exception to using white space
428 freely is listed in the next guideline.
429
430 @@@ Example:
431
432 int firstValue   = 0;
433 int someValue    = 0;
434 int anotherValue = 0;
435 int thisVariable = 0;
436
437 if ( thisVariable == thatVariable )
438
439 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
440
441
442 @@ Don't use white space around structure operators
443
444 @@@ Explanation:
445
446 - structure pointer operator ( "->" ) 
447 - member operator ( "." )
448 - functions and parentheses
449
450 It is a general coding practice to put pointers, references, and
451 function parentheses next to names.  With spaces, the connection
452 between the object and variable/function name is not as clear.
453
454 @@@ Example:
455
456 aStruct->aMember;
457 aStruct.aMember;
458 FunctionName();
459
460 @@@ Instead of:
461 aStruct -> aMember;
462 aStruct .  aMember;
463 FunctionName ();
464
465
466 @@ Make the last brace of a function stand out
467
468 @@@ Example:
469
470 int function1( ... )
471 {
472    ...code...
473    return( retCode );
474
475 }   /* -END- function1 */
476
477
478 int function2( ... )
479 {
480 }   /* -END- function2 */
481
482
483 @@@ Instead of:
484
485 int function1( ... )
486 {
487    ...code...
488    return( retCode );
489 }
490 int function2( ... )
491 {
492 }
493
494 @@@ Note: Use 1 blank line before the closing brace and 2 lines
495 afterwards.  This makes the end of function standout to the most
496 casual viewer.  Although function comments help seperate functions,
497 this is still a good coding practice.  In fact, I follow these rules
498 when using blocks in "for", "while", "do" loops, and long if {}
499 statements too.  After all whitespace is free!
500
501 @@@ Status: developer-discrection on the number of blank lines.
502 Enforced is the end of function comments.
503
504
505 @@ Use 3 character indentions
506
507 @@@ Explanation:
508
509 If some use 8 character TABs and some use 3 character TABs, the code
510 can look *very* ragged.  So use 3 character indentions only.  If you
511 like to use TABs, pass your code through a filter such as "expand -t3"
512 before checking in your code.
513
514 @@@ Example:
515
516 static const char * const url_code_map[256] =
517 {
518    NULL, ...
519 };
520
521
522 int function1( ... )
523 {
524    if ( 1 )
525    {
526       return( ALWAYS_TRUE );
527    }
528    else
529    {
530       return( HOW_DID_YOU_GET_HERE );
531    }
532
533    return( NEVER_GETS_HERE );
534
535 }
536
537
538 @ Initializing
539
540
541 @@ Initialize all variables
542
543 @@@ Explanation:
544
545 Do not assume that the variables declared will not be used until
546 after they have been assigned a value somewhere else in the
547 code.  Remove the chance of accidentally using an unassigned
548 variable.
549
550 @@@ Example:
551
552 short anShort = 0;
553 float aFloat  = 0;
554 struct *ptr = NULL;
555
556 @@@ Note: It is much easier to debug a SIGSEGV if the message says
557 you are trying to access memory address 00000000 and not
558 129FA012; or arrayPtr[20] causes a SIGSEV vs. arrayPtr[0].
559
560 @@@ Status: developer-discrection if and only if the variable is
561 assigned a value "shortly after" declaration.
562
563
564 @ Functions
565
566
567 @@ Name functions that return a boolean as a question.
568
569 @@@ Explanation:
570
571 Value should be phrased as a question that would logically be
572 answered as a true or false statement
573
574 @@@ Example:
575
576 ShouldWeBlockThis();
577 ContainsAnImage();
578 IsWebPageBlank();
579
580
581 @@ Always specify a return type for a function.
582
583 @@@ Explanation:
584
585 The default return for a function is an int.  To avoid ambiguity,
586 create a return for a function when the return has a purpose, and
587 create a void return type if the function does not need to return
588 anything.
589
590
591 @@ Minimize function calls when iterating by using variables
592
593 @@@ Explanation:
594
595 It is easy to write the following code, and a clear argument can
596 be made that the code is easy to understand:
597
598 @@@ Example:
599
600 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
601 {
602    ....
603 }
604
605 @@@ Note: Unfortunately, this makes a function call for each and every
606 iteration.  This increases the overhead in the program, because the
607 compiler has to look up the function each time, call it, and return a
608 value.  Depending on what occurs in the blockListLength() call, it
609 might even be creating and destroying structures with each iteration,
610 even though in each case it is comparing "cnt" to the same value, over
611 and over.  Remember too - even a call to blockListLength() is a
612 function call, with the same overhead.
613
614 Instead of using a function call during the iterations, assign
615 the value to a variable, and evaluate using the variable.
616
617 @@@ Example:
618
619 size_t len = blockListLength();
620
621 for ( size_t cnt = 0; cnt < len; cnt ++ )
622 {
623    ....
624 }
625
626 @@@ Exceptions: if the value of blockListLength() *may* change or could
627 *potentially* change, then you must code the function call in the
628 for/while loop.
629
630
631 @@ Pass and Return by Const Reference
632
633 @@@ Explanation:
634
635 This allows a developer to define a const pointer and call your
636 function.  If your function does not have the const keyword, we
637 may not be able to use your function.  Consider strcmp, if it
638 were defined as:
639    extern int strcmp( char *s1, char *s2 );
640
641 I could then not use it to compare argv's in main:
642    int main( int argc, const char *argv[] )
643    {
644      strcmp( argv[0], "junkbusters" );
645    }
646
647 Both these pointers are *const*!  If the c runtime library maintainers
648 do it, we should too.
649
650
651 @@ Pass and Return by Value
652
653 @@@ Explanation:
654
655 Most structures cannot fit onto a normal stack entry (i.e. they
656 are not 4 bytes or less).  Aka, a function declaration like:
657    int load_aclfile( struct client_state csp )
658
659 would not work.  So, to be consistent, we should declare all
660 prototypes with "pass by value":
661    int load_aclfile( struct client_state *csp )
662
663
664 @@ Use #include <fileName> and #include "fileName" for locals
665
666 @@@ Explanation:
667
668 Your include statements should contain the file name without a
669 path.  The path should be listed in the Makefile, using -I as
670 processor directive to search the indicated paths.  An exception
671 to this would be for some proprietary software that utilizes a
672 partial path to distinguish their header files from system or
673 other header files.
674
675 @@@ Example:
676
677 #include <iostream.h>     /* This is not a local include */
678 #include "config.h"       /* This IS a local include */
679
680 @@@ Exception:
681
682 /* This is not a local include, but requires a path element. */
683 #include <sys/fileName.h>
684
685 @@@ Note: Please! do not add "-I." to the Makefile without a _very_
686 good reason.  This duplicates the #include "file.h" behaviour.
687
688
689 @@ Provide multiple inclusion protection
690
691 @@@ Explanation:
692
693 Prevents compiler and linker errors resulting from redefinition of
694 items.
695
696 Wrap each header file with the following syntax to prevent multiple
697 inclusions of the file.  Of course, replace FILENAME_UPPERCASE with
698 your file name, with "." Changed to "_", and make it uppercase.
699
700 @@@ Example:
701
702 #ifndef _PROJECT_H
703 #define _PROJECT_H
704    ...
705 #endif /* ndef _PROJECT_H */
706
707
708 @@ Where Possible, Use Forward Struct Declaration Instead of Includes
709
710 @@@ Explanation:
711
712 Useful in headers that include pointers to other struct's.
713 Modifications to excess header files may cause needless compiles.
714
715 @@@ Example:
716
717 /*********************************************************************
718  * We're avoiding an include statement here!
719  *********************************************************************/
720 struct file_list;
721 extern file_list *xyz;
722
723 @@@ Note: If you declare "file_list xyz;" (without the pointer), then
724 including the proper header file is necessary.  If you only want to
725 prototype a pointer, however, the header file is unneccessary.
726
727 @@@ Status: Use with discrection.
728
729
730 @ General Coding Practices
731
732
733 @@ Provide a default case for all switch statements
734
735 @@@ Explanation:
736
737 What you think is guaranteed is never really guaranteed.  The value
738 that you don't think you need to check is the one that someday will be
739 passed.  So, to protect yourself from the unknown, always have a
740 default step in a switch statement.
741
742 @@@ Example:
743
744 switch( hash_string( cmd ) )
745 {
746    case hash_actions_file :
747       ... code ...
748       break;
749
750    case hash_confdir :
751       ... code ...
752       break;
753
754    default :
755       log_error( ... );
756       ... anomly code goes here ...
757       continue; / break; / exit( 1 ); / etc ...
758
759 } /* end switch( hash_string( cmd ) ) */
760
761 @@@ Note: If you already have a default condition, you are obviously
762 exempt from this point.  Of note, most of the WIN32 code calls
763 `DefWindowProc' after the switch statement.  This API call
764 *should* be included in a default statement.
765
766 @@@ Another Note: This is not so much a readability issue as a robust
767 programming issue.  The "anomly code goes here" may be no more than a
768 print to the STDERR stream (as in load_config).  Or it may really be
769 an ABEND condition.
770
771 @@@ Status: Programmer discretion is advised.
772
773
774 @@ Try to avoid falling through cases in a switch statement.
775
776 @@@ Explanation:
777
778 In general, you will want to have a 'break' statement within each
779 'case' of a switch statement.  This allows for the code to be more
780 readable and understandable, and furthermore can prevent unwanted
781 surprises if someone else later gets creative and moves the code
782 around.
783
784 The language allows you to plan the fall through from one case
785 statement to another simply by omitting the break statement within the
786 case statement.  This feature does have benefits, but should only be
787 used in rare cases.  In general, use a break statement for each case
788 statement.
789
790 If you choose to allow fall through, you should comment both the fact
791 of the fall through and reason why you felt it was necessary.
792
793
794 @@ Use 'long' or 'short' Instead of 'int'
795
796 @@@ Explanation:
797
798 On 32-bit platforms, int usually has the range of long.  On 16-bit
799 platforms, int has the range of short.
800
801 @@@ Status: open-to-debate.  In the case of most FSF projects
802 (including X/GNU-Emacs), there are typedefs to int4, int8, int16, (or
803 equivalence ... I forget the exact typedefs now).  Should we add these
804 to IJB now that we have a "configure" script?
805
806
807 @@ Declare each variable and struct on its own line.
808
809 @@@ Explanation:
810
811 It can be tempting to declare a series of variables all on one line.
812 Don't.
813
814 @@@ Example:
815
816 long a = 0;
817 long b = 0;
818 long c = 0;
819
820 @@@ Instead of:
821
822 long a, b, c;
823
824 @@@ Explanation:
825 - there is more room for comments on the individual variables
826 - easier to add new variables without messing up the original ones
827 - when searching on a variable to find its type, there is less
828   clutter to "visually" eliminate
829
830 @@@ Exceptions: when you want to declare a bunch of loop variables or
831 other trivial variables; feel free to declare them on 1 line.  You
832 should, although, provide a good comment on their functions.
833
834 @@@ Status: developer-discrection.
835
836
837 @@ Use malloc/zalloc sparingly
838
839 @@@ Explanation:
840
841 Create a local stuct (on the stack) if the variable will live
842 and die within the context of one function call.
843
844 Only "malloc" a struct (on the heap) if the variable's life will
845 extend beyond the context of one function call.
846
847 @@@ Example:
848
849 If a function creates a struct and stores a pointer to it in a
850 list, then it should definately be allocated via `malloc'.
851
852
853 @@ The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
854
855 @@@ Explanation:
856
857 If you have to "malloc" an instance, you are responsible for insuring
858 that the instance is `free'd, even if the deallocation event falls
859 within some other programmer's code.  You are also responsible for
860 ensuring that deletion is timely (i.e. not too soon, not too late).
861 This is known as "low-coupling" and is a "good thing (tm)".  You may
862 need to offer a free/unload/destuctor type function to accomodate
863 this.
864
865 @@@ Example:
866
867 int load_re_filterfile( struct client_state *csp ) { ... }
868 static void unload_re_filterfile( void *f ) { ... }
869
870 @@@ Exceptions:
871
872 The developer cannot be expected to provide `free'ing functions for 
873 C run-time library functions ... such as `strdup'.
874
875 @@@ Status: developer-discrection.  The "main" use of this standard is
876 for allocating and freeing data structures (complex or nested).
877
878
879 @@ Add loaders to the `file_list' structure and in order
880
881 @@@ Explanation:
882
883 I have ordered all of the "blocker" file code to be in alpha
884 order.  It is easier to add/read new blockers when you expect a
885 certain order.
886
887 @@@ Note: It may appear that the alpha order is broken in places by
888 POPUP tests coming before PCRS tests.  But since POPUPs can also
889 be referred to as KILLPOPUPs, it is clear that it should come
890 first.
891
892
893 @@ "Uncertain" new code and/or changes to exitinst code, use FIXME
894
895 @@@ Explanation:
896
897 If you have enough confidence in new code or confidence in your
898 changes, but are not *quite* sure of the reprocussions, add this:
899
900 /* FIXME: this code has a logic error on platform XYZ,
901  * attempthing to fix
902  */
903 #ifdef PLATFORM
904    ...changed code here...
905 #endif
906
907 or:
908
909 /* FIXME: I think the original author really meant this... */
910    ...changed code here...
911
912 or:
913
914 /* FIXME: new code that *may* break something else... */
915    ...new code here...
916
917 @@@ Note: If you make it clear that this may or may not be a "good
918 thing (tm)", it will be easier to identify and include in the project
919 (or conversly exclude from the project).
920
921
922 @ Addendum: Template for files and function comment blocks:
923
924
925 @@@ Example for file comments:
926
927 const char FILENAME_rcs[] = "$Id: STANDARDS.txt,v 1.3 2001/07/02 01:50:04 iwanttokeepanon Exp $";
928 /*********************************************************************
929  *
930  * File        :  $Source: /cvsroot/ijbswa/current/doc/STANDARDS.txt,v $
931  *
932  * Purpose     :  (Fill me in with a good description!)
933  *
934  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
935  *                IJBSWA team.  http://ijbswa.sourceforge.net
936  *
937  *                Based on the Internet Junkbuster originally written
938  *                by and Copyright (C) 1997 Anonymous Coders and 
939  *                Junkbusters Corporation.  http://www.junkbusters.com
940  *
941  *                This program is free software; you can redistribute it 
942  *                and/or modify it under the terms of the GNU General
943  *                Public License as published by the Free Software
944  *                Foundation; either version 2 of the License, or (at
945  *                your option) any later version.
946  *
947  *                This program is distributed in the hope that it will
948  *                be useful, but WITHOUT ANY WARRANTY; without even the
949  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
950  *                PARTICULAR PURPOSE.  See the GNU General Public
951  *                License for more details.
952  *
953  *                The GNU General Public License should be included with
954  *                this file.  If not, you can view it at
955  *                http://www.gnu.org/copyleft/gpl.html
956  *                or write to the Free Software Foundation, Inc., 59
957  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
958  *
959  * Revisions   :
960  *    $Log: STANDARDS.txt,v $
961  *    Revision 1.3  2001/07/02 01:50:04  iwanttokeepanon
962  *    A modified STANDARDS.txt file.  I removed my XEmacs test lines (commited in v1.2)
963  *    and made the file Outline-mode compatible.  I used "@" for my header lines instead
964  *    of "*" (which interfered in some C comments).  I also removed the formfeed character
965  *    from the `outline-regexp' variable because it interfered with the "H" file header and
966  *    the "C" file header comments.
967  *
968  *    All of the "stardards points/issues" are still available for discussion, cussing,
969  *    and/or flaming <G>.
970  *
971  *    Revision 1.2  2001/06/28 04:02:42  iwanttokeepanon
972  *    Testing XEmacs and VC/CVS modes.  Will this work?   We shall see...
973  *
974  *    Revision 1.1  2001/06/28 03:01:32  iwanttokeepanon
975  *    A suggested standard for IJB.  Outline-mode formatting and spell checking to follow.  Developer comments encouraged and requested.
976  *
977  *
978  *********************************************************************/
979 \f
980
981 #include "config.h"
982
983    ...necessary include files for us to do our work...
984
985 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
986
987
988 @@@ Note: This declares the rcs variables that should be added to the
989 "show-proxy-args" page.  If this is a brand new creation by you, you
990 are free to change the "Copyright" section to represent the rights you
991 wish to maintain.
992
993 @@@ Note: The formfeed character that is present right after the
994 comment flower box is handy for (X|GNU)Emacs users to skip the verbige
995 and get to the heart of the code (via `forward-page' and
996 `backward-page').  Please include it if you can.
997
998 @@@ Example for file header comments:
999
1000 #ifndef _FILENAME_H
1001 #define _FILENAME_H
1002 #define FILENAME_H_VERSION "$Id: STANDARDS.txt,v 1.3 2001/07/02 01:50:04 iwanttokeepanon Exp $"
1003 /*********************************************************************
1004  *
1005  * File        :  $Source: /cvsroot/ijbswa/current/doc/STANDARDS.txt,v $
1006  *
1007  * Purpose     :  (Fill me in with a good description!)
1008  *
1009  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
1010  *                IJBSWA team.  http://ijbswa.sourceforge.net
1011  *
1012  *                Based on the Internet Junkbuster originally written
1013  *                by and Copyright (C) 1997 Anonymous Coders and 
1014  *                Junkbusters Corporation.  http://www.junkbusters.com
1015  *
1016  *                This program is free software; you can redistribute it 
1017  *                and/or modify it under the terms of the GNU General
1018  *                Public License as published by the Free Software
1019  *                Foundation; either version 2 of the License, or (at
1020  *                your option) any later version.
1021  *
1022  *                This program is distributed in the hope that it will
1023  *                be useful, but WITHOUT ANY WARRANTY; without even the
1024  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
1025  *                PARTICULAR PURPOSE.  See the GNU General Public
1026  *                License for more details.
1027  *
1028  *                The GNU General Public License should be included with
1029  *                this file.  If not, you can view it at
1030  *                http://www.gnu.org/copyleft/gpl.html
1031  *                or write to the Free Software Foundation, Inc., 59
1032  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
1033  *
1034  * Revisions   :
1035  *    $Log: STANDARDS.txt,v $
1036  *    Revision 1.3  2001/07/02 01:50:04  iwanttokeepanon
1037  *    A modified STANDARDS.txt file.  I removed my XEmacs test lines (commited in v1.2)
1038  *    and made the file Outline-mode compatible.  I used "@" for my header lines instead
1039  *    of "*" (which interfered in some C comments).  I also removed the formfeed character
1040  *    from the `outline-regexp' variable because it interfered with the "H" file header and
1041  *    the "C" file header comments.
1042  *
1043  *    All of the "stardards points/issues" are still available for discussion, cussing,
1044  *    and/or flaming <G>.
1045  *
1046  *    Revision 1.2  2001/06/28 04:02:42  iwanttokeepanon
1047  *    Testing XEmacs and VC/CVS modes.  Will this work?   We shall see...
1048  *
1049  *    Revision 1.1  2001/06/28 03:01:32  iwanttokeepanon
1050  *    A suggested standard for IJB.  Outline-mode formatting and spell checking to follow.  Developer comments encouraged and requested.
1051  *
1052  *
1053  *********************************************************************/
1054 \f
1055
1056 #include "project.h"
1057
1058 #ifdef __cplusplus
1059 extern "C" {
1060 #endif
1061
1062    ... function headers here ...
1063
1064
1065 /* Revision control strings from this header and associated .c file */
1066 extern const char FILENAME_rcs[];
1067 extern const char FILENAME_h_rcs[];
1068
1069
1070 #ifdef __cplusplus
1071 } /* extern "C" */
1072 #endif
1073
1074 #endif /* ndef _FILENAME_H */
1075
1076 /*
1077   Local Variables:
1078   tab-width: 3
1079   end:
1080 */
1081
1082
1083 @@@ Example for function comments:
1084
1085 /*********************************************************************
1086  *
1087  * Function    :  FUNCTION_NAME
1088  *
1089  * Description :  (Fill me in with a good description!)
1090  *
1091  * Parameters  :
1092  *          1  :  param1 = pointer to an important thing
1093  *          2  :  x      = pointer to something else
1094  *
1095  * Returns     :  0 => Ok, everything else is an error.
1096  *
1097  *********************************************************************/
1098 int FUNCTION_NAME( void *param1, const char *x )
1099 {
1100    ...
1101    return( 0 );
1102
1103 }
1104
1105
1106 @@@ Note: If we all follow this practice, we should be able to parse
1107 our code to create a "self-documenting" web page.
1108
1109
1110 @ Local variables for this standards file
1111
1112
1113 \f
1114 Local variables:
1115 mode: outline
1116 mode: auto-fill
1117 outline-regexp: "[@]+"
1118 tab-width: 3
1119 End: