Coding Standards
General Principles
- Use PascalCase for class names, method names, properties, and public fields
- Use camelCase for local variables, parameters, and private fields
- Use UPPER_CASE for constants
- Use _camelCase for private fields (underscore prefix)
Specific Rules
Element | Convention | Example |
---|---|---|
Classes | PascalCase | GraphExtractService |
Interfaces | "I" prefix + PascalCase | IGraphExtractService |
Methods | PascalCase | ProcessImageAsync |
Properties | PascalCase | ControllerName |
Private Fields | _camelCase | _graphExtractService |
Parameters | camelCase | imageUri |
Local Variables | camelCase | result |
Constants | UPPER_CASE | API_ENDPOINT |
Namespace Convention
KikiWriting uses a namespace hierarchy that matches the folder structure, starts with Kiki: