C programming/House of Technology C coding policy - Revision history

Heth: /* Commenting code */

2024-07-01T12:35:43Z

‎Commenting code

2024-04-22T05:32:46Z

‎Commenting code

2023-05-11T08:35:35Z

‎Function names

2022-09-15T15:18:47Z

‎Example

2021-02-03T07:49:45Z

‎Commenting code

2020-11-30T07:29:01Z

‎Links

2020-11-30T07:28:24Z

‎Links

2013-07-05T04:40:34Z

‎Function headers

2012-06-29T07:04:17Z

‎References

2012-06-14T11:51:26Z

‎.c files

@@ Line 73: / Line 73: @@
 =Documenting=
 ==Commenting code==
 Write what the purpose of the code is - not what the code do. A fellow programmer knows how the programming language works - but not the purpose and function of your code.
 *What - What is the purpose

@@ Line 74: / Line 74: @@
 ==Commenting code==
 Write what the purpose of the code is - not what the code do. A fellow programmer knows how the programming language works - but not the purpose and function of your code.
-*What - What is the purpose of the
+*What - What is the purpose
 *Why - Why is it necessary
 *How - How does it do it

@@ Line 13: / Line 13: @@
 *All function names should describe purpose and function.
 *Use _ (underscore) as space.
-*Use '''galaxy_soarsystem_planet''' approach instead of '''planet_solarsystem_galaxy'''
+*Use '''galaxy_solarsystem_planet''' approach instead of '''planet_solarsystem_galaxy'''
 {|
 |-
@@ Line 31: / Line 31: @@
 |-
 |}
 ==Abbreviations==

@@ Line 97: / Line 97: @@
          /* Allocate memory to store the ciphertext  */
          ciphertext = (int *) malloc(ciphertext_size * sizeof(int));
-         if ( cipher == NULL ) {
+         if ( ciphertext == NULL ) {
                  err(2,"Can't allocate memory for ciphertext message.");
                  exit(2);

@@ Line 75: / Line 75: @@
 ==Commenting code==
 Write what the purpose of the code is - not what the code do. A fellow programmer knows how the programming language works - but not the purpose and function of your code.
 ===Example===
 The example below is a codesnip of a brute force decryption attack program, which searches all keys until it find a partial known/guessed '''cleartext''' message - known as a '''crib''' in the crypted message known as the '''ciphertext'''.

@@ Line 160: / Line 160: @@
 =Links=
-*https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst
+*[https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst Linus Torvalds Coding Style]
 =References=
 <references/>
 [[Category:C]]

@@ Line 149: / Line 149: @@
 Author..: name
 ***************************************************************************
-Abstract: Brief description
+Abstract: Description
 Inputs..: Parameters
 Outputs.: Changes/return
 ToDo....: Wanted enhancements
 ***************************************************************************
@@ Line 157: / Line 158: @@
 **************************************************************************/
 </source>
 =Links=
 *[https://computing.llnl.gov/linux/slurm/coding_style.pdf Linus Torvalds: Linux kernel coding style]

@@ Line 134: / Line 134: @@
 Purpose.: The purpose of the module. (one or two lines)
 ***************************************************************************
-Cavets..: Description of problems and future extensions (TODO's)
+ToDo....: Description of problems and future extensions (TODO's)
 ***************************************************************************
 Modification log:
@@ Line 142: / Line 142: @@
 ***************************************************************************/
 </source>
 ==Function headers==
 <source lang=c>