Skip to content

Add section to code style guide for static functions #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
automas-dev merged 2 commits into from
Sep 12, 2026
Merged

Add section to code style guide for static functions #45

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d5c3f2
Add section to code style guide for static functions
automas-dev Sep 12, 2026
ddd0279
Merge branch 'main' into docs_static_functions
automas-dev Sep 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions design/style_guide/code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
<!-- Table of Contents only links to level 2 headers -->
\[ [Header Guards](#header-guards) \]
\[ [Function Names](#function-names) \]
\[ [Static Functions](#static-functions) \]
\[ [Global Variables](#global-variables) \]
\[ [Memory Ownership](#memory-ownership) \]

Expand Down Expand Up @@ -38,6 +39,12 @@ All C++ code or C code outside src/ should use `#pragma once`
Function names should include the module (ie. path) as a prefix using snake
case.

## Static Functions

Static functions should be declared (forward declared) at the top of a C file,
below includes and file-level variables, and defined below all non-static
(externally visible) functions in the file.

## Global Variables

Global variables should not be shared between files, but for several systems it
Expand Down