Nếu có một bộ các phương pháp hay nhất hoặc quy ước tuỳ chỉnh mà bạn muốn Gemini Code Assist kiểm tra, bạn có thể thêm tệp styleguide.md vào thư mục gốc .gemini/ của kho lưu trữ. Tệp này được coi là tệp văn bản thông thường và mở rộng lời nhắc tiêu chuẩn mà tính năng Trợ giúp mã Gemini sử dụng.
Mẫu xem xét mã chuẩn
Khi bạn không chỉ định hướng dẫn kiểu tuỳ chỉnh, đây là các danh mục chính về các khía cạnh mà Gemini Code Assist tập trung xem xét mã:
Tính chính xác: Đảm bảo mã hoạt động như dự kiến và xử lý các trường hợp ngoại lệ, kiểm tra lỗi logic, điều kiện tương tranh hoặc sử dụng API không chính xác.
Hiệu suất: Xác định các nút thắt cổ chai tiềm ẩn về hiệu suất hoặc các khu vực cần tối ưu hoá, chẳng hạn như vòng lặp quá mức, rò rỉ bộ nhớ, cấu trúc dữ liệu không hiệu quả, tính toán thừa, ghi nhật ký quá mức và thao tác với chuỗi không hiệu quả.
Khả năng bảo trì: Đánh giá khả năng đọc mã, tính mô-đun và việc tuân thủ các phương pháp hay nhất cũng như thành ngữ ngôn ngữ. Nhắm đến việc đặt tên không phù hợp cho các biến, hàm và lớp, thiếu chú thích hoặc tài liệu, mã phức tạp, trùng lặp mã, định dạng không nhất quán và số ma thuật.
Bảo mật: Xác định các lỗ hổng tiềm ẩn trong việc xử lý dữ liệu hoặc xác thực dữ liệu đầu vào, chẳng hạn như lưu trữ không an toàn dữ liệu nhạy cảm, tấn công chèn, biện pháp kiểm soát quyền truy cập không đầy đủ, Hành vi giả mạo yêu cầu trên nhiều trang web (CSRF) và Tham chiếu đối tượng trực tiếp không an toàn (IDOR).
Khác: Các chủ đề khác được xem xét khi xem xét yêu cầu rút, chẳng hạn như kiểm thử, hiệu suất, khả năng mở rộng, mô-đun và khả năng sử dụng lại, cũng như hoạt động ghi nhật ký và theo dõi lỗi.
Thêm tệp cấu hình
Thư mục .gemini/ lưu trữ mọi tệp cấu hình liên quan đến tính năng Trợ giúp mã Gemini, chẳng hạn như config.yaml và styleguide.md.
Tệp config.yaml chứa nhiều tính năng có thể định cấu hình mà bạn có thể bật hoặc tắt. Tệp văn bản styleguide.md là hướng dẫn về kiểu, hướng dẫn Gemini Code Assist bằng một số quy tắc cụ thể mà bạn muốn Gemini Code Assist tuân theo khi thực hiện việc xem xét mã.
Để thêm các tệp cấu hình này, hãy tạo các tệp đó trong thư mục .gemini/ của kho lưu trữ và sử dụng bảng sau làm tài liệu tham khảo:
Đoạn mã sau đây là ví dụ về tệp config.yaml có chế độ cài đặt mặc định. Nếu bạn không thêm chế độ cài đặt cụ thể nào, thì tính năng Trợ lý mã Gemini sẽ sử dụng chế độ cài đặt mặc định. Bạn có thể sử dụng đoạn mã này làm mẫu để tạo tệp config.yaml của riêng mình:
have_fun: true
code_review:
disable: false
comment_severity_threshold: MEDIUM
max_review_comments: -1
pull_request_opened:
help: false
summary: true
code_review: true
Đoạn mã sau đây là ví dụ về tệp config.yaml có các chế độ cài đặt tuỳ chỉnh:
$schema: "http://json-schema.org/draft-07/schema#"
title: RepoConfig
description: Configuration for Gemini Code Assist on a repository. All fields are optional and have default values.
type: object
properties:
have_fun:
type: boolean
description: Enables fun features such as a poem in the initial pull request summary. Default: true.
code_review:
type: object
description: Configuration for code reviews. All fields are optional and have default values.
properties:
disable:
type: boolean
description: Disables Gemini from acting on pull requests. Default: false.
comment_severity_threshold:
type: string
enum:
- LOW
- MEDIUM
- HIGH
- CRITICAL
description: The minimum severity of review comments to consider. Default: MEDIUM.
max_review_comments:
type: integer
format: int64
description: The maximum number of review comments to consider. Use -1 for unlimited. Default: -1.
pull_request_opened:
type: object
description: Configuration for pull request opened events. All fields are optional and have default values.
properties:
help:
type: boolean
description: Posts a help message on pull request open. Default: false.
summary:
type: boolean
description: Posts a pull request summary on the pull request open. Default: true.
code_review:
type: boolean
description: Posts a code review on pull request open. Default: true.
Đoạn mã sau đây là ví dụ về tệp styleguide.md:
# Company X Python Style Guide
# Introduction
This style guide outlines the coding conventions for Python code developed at Company X.
It's based on PEP 8, but with some modifications to address specific needs and
preferences within our organization.
# Key Principles
* **Readability:** Code should be easy to understand for all team members.
* **Maintainability:** Code should be easy to modify and extend.
* **Consistency:** Adhering to a consistent style across all projects improves
collaboration and reduces errors.
* **Performance:** While readability is paramount, code should be efficient.
# Deviations from PEP 8
## Line Length
* **Maximum line length:** 100 characters (instead of PEP 8's 79).
* Modern screens allow for wider lines, improving code readability in many cases.
* Many common patterns in our codebase, like long strings or URLs, often exceed 79 characters.
## Indentation
* **Use 4 spaces per indentation level.** (PEP 8 recommendation)
## Imports
* **Group imports:**
* Standard library imports
* Related third party imports
* Local application/library specific imports
* **Absolute imports:** Always use absolute imports for clarity.
* **Import order within groups:** Sort alphabetically.
## Naming Conventions
* **Variables:** Use lowercase with underscores (snake_case): `user_name`, `total_count`
* **Constants:** Use uppercase with underscores: `MAX_VALUE`, `DATABASE_NAME`
* **Functions:** Use lowercase with underscores (snake_case): `calculate_total()`, `process_data()`
* **Classes:** Use CapWords (CamelCase): `UserManager`, `PaymentProcessor`
* **Modules:** Use lowercase with underscores (snake_case): `user_utils`, `payment_gateway`
## Docstrings
* **Use triple double quotes (`"""Docstring goes here."""`) for all docstrings.**
* **First line:** Concise summary of the object's purpose.
* **For complex functions/classes:** Include detailed descriptions of parameters, return values,
attributes, and exceptions.
* **Use Google style docstrings:** This helps with automated documentation generation.
```python
def my_function(param1, param2):
"""Single-line summary.
More detailed description, if necessary.
Args:
param1 (int): The first parameter.
param2 (str): The second parameter.
Returns:
bool: The return value. True for success, False otherwise.
Raises:
ValueError: If `param2` is invalid.
"""
# function body here
```
## Type Hints
* **Use type hints:** Type hints improve code readability and help catch errors early.
* **Follow PEP 484:** Use the standard type hinting syntax.
## Comments
* **Write clear and concise comments:** Explain the "why" behind the code, not just the "what".
* **Comment sparingly:** Well-written code should be self-documenting where possible.
* **Use complete sentences:** Start comments with a capital letter and use proper punctuation.
## Logging
* **Use a standard logging framework:** Company X uses the built-in `logging` module.
* **Log at appropriate levels:** DEBUG, INFO, WARNING, ERROR, CRITICAL
* **Provide context:** Include relevant information in log messages to aid debugging.
## Error Handling
* **Use specific exceptions:** Avoid using broad exceptions like `Exception`.
* **Handle exceptions gracefully:** Provide informative error messages and avoid crashing the program.
* **Use `try...except` blocks:** Isolate code that might raise exceptions.
# Tooling
* **Code formatter:** [Specify formatter, e.g., Black] - Enforces consistent formatting automatically.
* **Linter:** [Specify linter, e.g., Flake8, Pylint] - Identifies potential issues and style violations.
# Example
```python
"""Module for user authentication."""
import hashlib
import logging
import os
from companyx.db import user_database
LOGGER = logging.getLogger(__name__)
def hash_password(password: str) -> str:
"""Hashes a password using SHA-256.
Args:
password (str): The password to hash.
Returns:
str: The hashed password.
"""
salt = os.urandom(16)
salted_password = salt + password.encode('utf-8')
hashed_password = hashlib.sha256(salted_password).hexdigest()
return f"{salt.hex()}:{hashed_password}"
def authenticate_user(username: str, password: str) -> bool:
"""Authenticates a user against the database.
Args:
username (str): The user's username.
password (str): The user's password.
Returns:
bool: True if the user is authenticated, False otherwise.
"""
try:
user = user_database.get_user(username)
if user is None:
LOGGER.warning("Authentication failed: User not found - %s", username)
return False
stored_hash = user.password_hash
salt, hashed_password = stored_hash.split(':')
salted_password = bytes.fromhex(salt) + password.encode('utf-8')
calculated_hash = hashlib.sha256(salted_password).hexdigest()
if calculated_hash == hashed_password:
LOGGER.info("User authenticated successfully - %s", username)
return True
else:
LOGGER.warning("Authentication failed: Incorrect password - %s", username)
return False
except Exception as e:
LOGGER.error("An error occurred during authentication: %s", e)
return False