Code Style Guide for Project B
Welcome to the Project B code style documentation! This guide outlines the preferred coding conventions to maintain consistency across the project.
Key Principles
Naming Conventions: Use
snake_case
for variables andcamelCase
for methods.
📌 Example:variable_name
vsmethodName
Indentation: Always use 4 spaces per level.
📌 Example:def example_function(): if True: print("Indented correctly")
Comments: Write concise, meaningful comments in English.
Tools & Resources
Additional Tips
- 🚫 Avoid trailing spaces in lines.
- 🧩 Use linters like ESLint or Pylint for automated checks.
- 📚 Refer to our official style guide for detailed rules.
Let me know if you need further clarification! 😊