Skip to content

Commit ffa144a

Browse files
authored
Update styleguide.md
1 parent 2d7e417 commit ffa144a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

.gemini/styleguide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,16 +65,16 @@ public bool MyMethod(int param1, string param2)
6565
return true; // Example return
6666
}
6767
## Generics
68+
* Utilize generics where appropriate to improve type safety and code reusability.
69+
* Use descriptive names for type parameters (e.g., TKey, TValue, TEntity) or a single T if the context is obvious.
6870

69-
Utilize generics where appropriate to improve type safety and code reusability.
70-
Use descriptive names for type parameters (e.g., TKey, TValue, TEntity) or a single T if the context is obvious.
7171
## Comments
72+
* Write clear and concise comments using // for single-line or end-of-line comments. Use /* ... */ for temporarily commenting out blocks of code (avoid committing this).
73+
* Use /// XML comments for documenting APIs (as described above).
74+
* Explain the why behind non-obvious code, not just the what.
75+
* Comment sparingly: Well-named variables, methods, and classes should make the code largely self-documenting.
76+
* Avoid commented-out code in the final commit. Use source control history instead.
7277

73-
Write clear and concise comments using // for single-line or end-of-line comments. Use /* ... */ for temporarily commenting out blocks of code (avoid committing this).
74-
Use /// XML comments for documenting APIs (as described above).
75-
Explain the why behind non-obvious code, not just the what.
76-
Comment sparingly: Well-named variables, methods, and classes should make the code largely self-documenting.
77-
Avoid commented-out code in the final commit. Use source control history instead.
7878
## Logging
7979

8080
Use a standard logging framework: Company Betagro uses [Specify framework, e.g., Microsoft.Extensions.Logging with Serilog/NLog, Serilog directly].

0 commit comments

Comments
 (0)