|
|
@@ -25,24 +25,24 @@
|
|
|
|
|
|
|
|
|
Примеры комментариев к ревью кода:
|
|
|
-1. Повышение эффективности кода:
|
|
|
-• "Рассмотрите возможность использования словаря вместо цикла для проверки существования элемента в списке".
|
|
|
+1. Повышение эффективности кода:
|
|
|
+• "Рассмотрите возможность использования словаря вместо цикла для проверки существования элемента в списке".
|
|
|
• "Этот участок кода можно рефакторить, чтобы использовать выражение-генератор".
|
|
|
-2. Улучшение читабельности:
|
|
|
-• "Имя переменной 'temp' недостаточно описывает ее, пожалуйста, придумайте более осмысленное имя".
|
|
|
-• "Функцию можно сделать более читабельной, добавив к ней doc-строку, объясняющую ее назначение".
|
|
|
-3. Обработка ошибок:
|
|
|
-• "Этот код не обрабатывает исключения должным образом, пожалуйста, добавьте блок try-except для обработки возможных ошибок".
|
|
|
-• "В данном случае не следует возвращать None, подумайте о том, чтобы вместо этого выбросить исключение".
|
|
|
-4. Безопасность:
|
|
|
-• "Убедитесь, что пользовательский ввод санирован правильно, чтобы избежать атак XSS и SQL-инъекций".
|
|
|
-• "Рассмотрите возможность использования библиотеки типа hashlib для безопасного хэширования паролей вместо модуля sha256".
|
|
|
-5. Тестовое покрытие:
|
|
|
-• "Этому коду нужно больше тестовых примеров, чтобы обеспечить полное покрытие и предотвратить регрессии".
|
|
|
-• "Пожалуйста, добавьте отрицательные тестовые случаи, чтобы проверить поведение кода в непредвиденных ситуациях".
|
|
|
-6. Стандарты кода и лучшие практики:
|
|
|
-• "Функция не должна иметь побочных эффектов, пожалуйста, отрефакторите ее, чтобы она возвращала только значение".
|
|
|
-• "Избегайте использования глобальных переменных, вместо них используйте свойства класса или аргументы функций".
|
|
|
+2. Улучшение читабельности:
|
|
|
+• "Имя переменной 'temp' недостаточно описывает ее, пожалуйста, придумайте более осмысленное имя".
|
|
|
+• "Функцию можно сделать более читабельной, добавив к ней doc-строку, объясняющую ее назначение".
|
|
|
+3. Обработка ошибок:
|
|
|
+• "Этот код не обрабатывает исключения должным образом, пожалуйста, добавьте блок try-except для обработки возможных ошибок".
|
|
|
+• "В данном случае не следует возвращать None, подумайте о том, чтобы вместо этого выбросить исключение".
|
|
|
+4. Безопасность:
|
|
|
+• "Убедитесь, что пользовательский ввод санирован правильно, чтобы избежать атак XSS и SQL-инъекций".
|
|
|
+• "Рассмотрите возможность использования библиотеки типа hashlib для безопасного хэширования паролей вместо модуля sha256".
|
|
|
+5. Тестовое покрытие:
|
|
|
+• "Этому коду нужно больше тестовых примеров, чтобы обеспечить полное покрытие и предотвратить регрессии".
|
|
|
+• "Пожалуйста, добавьте отрицательные тестовые случаи, чтобы проверить поведение кода в непредвиденных ситуациях".
|
|
|
+6. Стандарты кода и лучшие практики:
|
|
|
+• "Функция не должна иметь побочных эффектов, пожалуйста, отрефакторите ее, чтобы она возвращала только значение".
|
|
|
+• "Избегайте использования глобальных переменных, вместо них используйте свойства класса или аргументы функций".
|
|
|
|
|
|
|
|
|
|
