add comment on function prototypes

This commit is contained in:
Bob Andrews 2024-09-08 17:08:40 +02:00 committed by GitHub
parent 31a0d5cc40
commit aff8248341
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -204,6 +204,18 @@ char* nextLine (FILE* f);
### Header files ### Header files
* All Headers should start with a copyright/license banner
* Function prototypes must be a single line, not contain the redundant
"extern" keyword, and followed by a brief comment that explains what
the function does, and separated from the next prototype by a blank
line:
~~~C
void __fastcall__ cclear (unsigned char length);
/* Clear part of a line (write length spaces). */
~~~
Headers that belong to the standard library (libc) must Headers that belong to the standard library (libc) must
conform with the C standard. That means: conform with the C standard. That means: