EDK II C Coding Standards Specification
1 Introduction
1.1 Abstract
1.2 Rationale
1.3 Scope
1.4 References
1.5 Glossary
2 Guiding Principles
2.1 Software Design
2.2 Principles for Software Maintenance
2.3 Additional Recommendations
3 Quick Reference
3.1 Naming
3.2 Formatting
3.3 Files: General Rules
3.4 Documentation
4 Naming Conventions
4.1 General Naming Rules
4.2 Directory Names
4.3 File Names
4.4 Identifiers
4.5 Global & Module Variables
4.6 Name Space Rules
5 Source Files
5.1 General Rules
5.2 Spacing
5.3 Include Files
5.4 Code File Structure
5.5 Preprocessor Directives
5.6 Declarations and Types
5.7 C Programming
5.8 Error Handling and ASSERT
6 Documenting Software
6.1 Documentation Concepts
6.2 Comments
6.3 What NOT to Comment
6.4 What You Must Comment
6.5 Types of Comments
6.6 Introducing Doxygen
6.7 How Doxygen Works
6.8 Special Documentation Blocks
6.9 Putting Documentation after Members
6.10 Special Commands
APPENDIX A Common Examples
APPENDIX B Reserved Identifiers
APPENDIX C Optimization and Performance
Tables
Table 1 Common Opposites
Table 2 EFI Supported Abbreviations
Table 3 EFI Supported Acronyms
Table 4 Reserved Keywords
Table 5 Permissible Escape Sequences (ISO/IEC 9899:1990 6.1.3.4)
Table 6 EFI Data Types (slightly modified from UEFI 2.3.1)
Table 7 Modifiers for Common EFI Data Types (reference the UEFI Specification and Beyond Bios)
Table 8 EFI Constants
Table 9 Parameter Modifiers
Table 10 Predicate Expression Examples
Table 11 HTML Character Entities
Table 12 HTML Commands
Published with GitBook
Table 4 Reserved Keywords
EDK II C Coding Standards Specification
DRAFT [11/18/2022 01:47:46]
Revision 2.2
Table 4 Reserved Keywords
EDK II C Coding Standards Specification
DRAFT [11/18/2022 01:47:46]
Revision 2.2