Coding standards - Revision history

KM4NNO at 16:02, 1 January 2021

2021-01-01T16:02:48Z

Wd6awp at 02:14, 28 January 2018

2018-01-28T02:14:13Z

KD3SU at 17:45, 27 January 2018

2018-01-27T17:45:01Z

KD3SU: misc

2018-01-27T17:38:36Z

misc

KD3SU: Added some info on C coding standards from GNU

2018-01-27T16:53:18Z

Added some info on C coding standards from GNU

KD3SU: Created page with "== Formatting: == * Formatting your source code. Keep the length of source lines to 79 characters or less, for maximum readability in the widest range of environments. It..."

2018-01-27T16:51:24Z

Created page with "== Formatting: == * Formatting your source code. Keep the length of source lines to 79 characters or less, for maximum readability in the widest range of environments. It..."

New page

== Formatting: ==
* Formatting your source code.

Keep the length of source lines to 79 characters or less, for maximum readability in the widest range of environments.

It is important to put the open-brace that starts the body of a C function in column one, so that they will start a defun. Several tools look for open-braces in column one to find the beginnings of C functions. These tools will not work on code not formatted that way.

Avoid putting open-brace, open-parenthesis or open-bracket in column one when they are inside a function, so that they won’t start a defun. The open-brace that starts a struct body can go in column one if you find it useful to treat that definition as a defun.

It is also important for function definitions to start the name of the function in column one. This helps people to search for function definitions, and may also help certain tools recognize them. Thus, using Standard C syntax, the format is this

For more details : https://www.gnu.org/prep/standards/html_node/Formatting.html#Formatting

== Comments ==
* Commenting your work.

* Syntactic Conventions: Clean use of C constructs.
* Names: Naming variables, functions, and files.
* System Portability: Portability among different operating systems.
* CPU Portability: Supporting the range of CPU types.
* System Functions: Portability and “standard” library functions.

@@ Line 2: / Line 2: @@
 == Open Source ==
-Allstar is an open-source project licensed under the GPL based on [https://www.asterisk.org/ Asterisk] and written in C. This means you get the source code and can make any modifications you wish provided you make your modifications available to the community.
+PTTLink is an open-source project licensed under the GPL based on [https://www.asterisk.org/ Asterisk] and written in C. This means you get the source code and can make any modifications you wish provided you make your modifications available to the community.
 ==  Formatting source code ==

← Older revision		Revision as of 02:14, 28 January 2018
Line 93:		Line 93:
	* CPU Portability: Supporting the range of CPU types.		* CPU Portability: Supporting the range of CPU types.
	* System Functions: Portability and “standard” library functions.		* System Functions: Portability and “standard” library functions.
		+
		+	[[Category:How to]]

← Older revision		Revision as of 17:45, 27 January 2018
Line 1:		Line 1:
		+
		+
		+	== Open Source ==
		+	Allstar is an open-source project licensed under the GPL based on [https://www.asterisk.org/ Asterisk] and written in C. This means you get the source code and can make any modifications you wish provided you make your modifications available to the community.
		+
	== Formatting source code ==		== Formatting source code ==

@@ Line 1: / Line 1: @@
-==  Formatting:	 ==
+==  Formatting source code ==
 Keep the length of source lines to 79 characters or less, for maximum readability in the widest range of environments.
@@ Line 13: / Line 12: @@
 == Comments ==
-* Commenting your work.
 Every program should start with a comment saying briefly what it is for. Example: ‘fmt - filter for simple filling of text’. This comment should be at the top of the source file containing the ‘main’ function of the program.
@@ Line 30: / Line 29: @@
 There is usually no purpose in restating the name of the function in the comment before it, because readers can see that for themselves. There might be an exception when the comment is so long that the function itself would be off the bottom of the screen.
-https://www.gnu.org/prep/standards/html_node/Comments.html#Comments
+See: https://www.gnu.org/prep/standards/html_node/Comments.html#Comments
 * CPU Portability:	  	Supporting the range of CPU types.
 * System Functions:	  	Portability and “standard” library functions.