Руководство по Trae IDE: простая настройка пользовательских правил искусственного интеллекта (Trae Rules)

С ростом использования ИИ в программировании многие разработчики, испытав на себе удобство программирования с помощью ИИ, ожидают, что у них будет "выделенный ИИ-инженер", который лучше поймет их потребности. В основе этого требования лежит способность ИИ точно следовать персональным инструкциям разработчика и конкретным спецификациям проекта. Чтобы удовлетворить эту потребность, компания Trae IDE Введена функция настройки правил искусственного интеллекта (Trae Rules), которая позволяет пользователям настраивать поведение искусственного интеллекта для автоматизации выполнения персонализированных задач.

I. Что такое правила

Trae Правила - это мощная функция, которая позволяет командам разработчиков или отдельным разработчикам настраивать и заставлять ИИ следовать определенным стилям кода и лучшим практикам при создании, интерпретации или изменении кода.

Представьте себе распространенный сценарий, в котором разработчику, использующему ИИ для помощи в программировании, необходимо повторять одни и те же инструкции для ИИ, такие как языковой стиль кода, ограничения фреймворка, которым должен следовать проект, уровень детализации и форматирования комментариев, правила безопасности, которые необходимо соблюдать, и т. д. Функция Trae Rules предварительно устанавливает эти нормы поведения для ИИ, чтобы он автоматически "читал" и следовал им каждый раз, когда отвечает. Trae Rules предварительно устанавливает эти поведенческие нормы для ИИ, чтобы он мог автоматически "читать" и следовать этим предустановленным правилам при каждом ответе. Таким образом, разработчикам не нужно постоянно напоминать об этом, а ИИ сможет стабильно выдавать контент, соответствующий ожиданиям. Что еще более важно, при решении различных задач разработки или смене проектов соответствующие правила Trae помогут ИИ точно адаптироваться к техническим требованиям текущей работы, что значительно повысит эффективность разработки. Файлы правил обычно представлены в удобном для чтения и редактирования текстовом формате или формате Markdown (например. user_rules.md ответить пением project_rules.md) существует для облегчения контроля версий и совместной работы разработчиков.

II. Инструкция по применению

После обновления Trae IDE до версии 0.5.1 и выше пользователи могут настраивать два типа правил:

01 Личные правила

Персональные правила - это правила, настраиваемые для ИИ на основе личных привычек и предпочтений разработчика с целью сделать работу ИИ более соответствующей индивидуальным потребностям пользователя. После установки персонального правила оно будет действовать во всех проектах пользователя. Например:

• язык: Укажите, будет ли ИИ отвечать в краткой, строгой или юмористической манере.
• Предпочтения операционной системы: AI просят предоставить решения или примеры кода для конкретной операционной системы, например Windows или macOS.
• Глубина содержания: Установите, должен ли ИИ предоставлять подробные объяснения, примеры кода или только основные выводы.
• метод взаимодействияНапример, пользователи могут предпочесть прямые ответы на риторические вопросы.

02 Правила проекта

Правило проекта - это набор правил, которые ИИ должен соблюдать для конкретного проекта. Эти правила действуют только в том проекте, в котором они настроены. Пример:

• стиль кодирования: Укажите отступы в коде (например, использовать ли пробелы или табуляции и сколько), соглашения об именовании (например, номенклатура верблюжьих кроссов). camelCase или номенклатура с подчеркиванием snake_case) и т.д.
• Ограничения, связанные с языком и фреймворком: Укажите предпочтительный язык программирования, который будет использоваться в проекте (например, Python или JavaScript), или обязательный фреймворк (например. React (или Django).
• Ограничения на использование API: AI явно запрещено использовать некоторые устаревшие или нерекомендованные API в генерируемом коде.

Как правило, если между личными правилами и правилами проекта возникает конфликт содержания, правила проекта имеют приоритет и отменяют соответствующие положения личных правил, чтобы обеспечить соблюдение спецификаций проекта.

В следующих разделах показано, как настроить каждое из этих двух правил ИИ:

Создание личных правил

1. В правом верхнем углу диалогового окна AI в Trae IDE нажмите на иконку "Настройки" и выберите опцию "Правила".
    
   После выполнения операции в интерфейсе появится окно конфигурации "Правила".
2. В области Личные правила нажмите на кнопку + 创建 user_rules.md Кнопка.
   Система автоматически создает user_rules.md файл и откройте его в редакторе.
   
3. открыть user_rules.md в файле введите правила, которым должен следовать ИИ на естественном языке. Например, вы можете указать: "Пожалуйста, используйте китайский язык для всех комментариев к коду и объясните основную функцию и значения параметров каждой функции".
4. Сохраните файл. После этого эти правила вступят в силу для всех поведений ИИ проекта.
   

Создание правил проекта

1. Сначала откройте проект в Trae IDE.
2. В правом верхнем углу диалогового окна AI нажмите на значок Settings (Настройки) и выберите Rules (Правила).
   После выполнения операции в интерфейсе появится окно конфигурации "Правила".
3. В области Правила проекта нажмите кнопку + 创建 project_rules.md Кнопка.
   
   Система автоматически создает корневой каталог текущего проекта в папке .trae/rules папку (если она еще не существует) и создайте папку project_rules.md Документация.
   
4. открыть project_rules.md Введите в файл правила, которым должен следовать ИИ для этого проекта.
5. Сохраните файл. Эти правила будут применяться только к поведению AI в текущем проекте.
   

Административные правила

В окне конфигурации "Правила" пользователи могут легко изменять существующие персональные правила и правила проекта, а также напрямую удалять файлы правил, которые больше не нужны.

• Изменить правила: после редактирования и сохранения содержимого файла правил, ИИ будет следовать обновленным правилам.
• Удаление файлов правил: Удалить user_rules.md возможно project_rules.md файл, все правила, ранее определенные в нем, будут аннулированы.

III. Практическая демонстрация

Далее мы расскажем вам на конкретном, реальном примере, как использовать правила Trae для повышения эффективности разработки.

Предположим, команда разработчиков работает над веб-проектом и решает использовать фреймворк Chakra UI для оптимизации стилей CSS. Чтобы гарантировать, что ИИ будет следовать этому решению в дальнейшей работе, вы можете добавить правила проекта (project_rules.md), добавьте следующую директиву:

请使用 Chakra UI 框架对本项目中的所有前端页面进行 CSS 相关的优化和重构。确保生成的组件符合 Chakra UI 的设计规范和最佳实践。

Когда это правило проекта настроено, ИИ (который может называться Builder или аналогичным именем в Trae IDE) будет автоматически ссылаться на это правило, когда разработчик запрашивает его для задач разработки, связанных с CSS.

Например, если настроить еще одно персональное правило, например "Объяснения кода должны быть подробными и объяснять ключевые шаги", то ИИ будет не только использовать фреймворк при выполнении описанной выше задачи модификации пользовательского интерфейса чакры, но и предоставлять более подробную информацию при объяснении его работы.

IV. Сценарии применения

Правила Trae можно использовать в самых разных сценариях, чтобы помочь командам разработчиков и отдельным разработчикам поддерживать согласованность кода, улучшить его сопровождаемость и уменьшить количество низкоуровневых ошибок в самых разных ситуациях. Ниже приведен список основных сценариев:

Сценарий 1: Командная работа и анализ кода

• эффект: Унификация стилей кода, уменьшение количества споров при рецензировании и повышение эффективности совместной работы.
• инструкцииНовым членам команды часто требуется время, чтобы адаптироваться к сложившемуся в команде стилю кода. Если установить правила проекта, которые определяют такие вещи, как соглашения об именовании переменных, порядок импорта модулей и архитектурные модели кода, поддерживаемые командой, ИИ будет следовать этим правилам при оказании помощи в программировании, гарантируя, что новые члены команды будут предоставлять код, соответствующий стилю команды. Кроме того, правила Trae могут помочь членам команды в форматировании кода, автоматическом исправлении несоответствующих фрагментов кода и обеспечении соблюдения спецификаций комментариев (например, требование, чтобы все публичные функции имели комментарии в стиле JSDoc), что снижает затраты на передачу информации о проблемах стиля на этапе проверки кода.

Сценарий 2: Сопровождение проекта и качество кода

• эффект: Помощь в обнаружении потенциальных ошибок в коде, постепенное улучшение старого кода и улучшение общей сопровождаемости проекта.
• инструкции: Для некоторых старых проектов с длительной историей и хаотичным стилем кода старый код можно исправлять поэтапно, постепенно вводя и уточняя правила Trae и сочетая их с диалоговыми командами ИИ, который может выявить код, не соответствующий новой спецификации, на основе правил и предоставить предложения по рефакторингу. В то же время, чтобы предотвратить появление новых низкоуровневых ошибок в процессе разработки, можно установить правила, например, предписывающие асинхронные операции await обязательно try-catch Структурная упаковка, обнаружение неиспользованных import операторы или переменные, запрещая использование подверженных ошибкам == и обеспечить использование === Проводите сравнения. Эти правила помогают уменьшить потенциальные проблемы во время выполнения и повысить надежность и долговременную поддерживаемость кода.

Сценарий 3: Оптимизация стека конкретных технологий

• эффект: Улучшение применения лучших практик для конкретных технологических стеков (например, React, Vue, Node.js).
• инструкции: В проектах фронтенда несогласованность в написании компонентов может затруднить их понимание и поддержку. Вы можете обеспечить последовательный способ написания компонентов, установив правила Trae, например, поощряя использование функциональных компонентов в проектах React (запрещая использование class злоупотребление компонентами), требующий, чтобы все компоненты props должны быть проверены на соответствие типу (с помощью TypeScript или PropTypes), а обязательные useEffect Зависимости от крючков должны быть объявлены полностью. Для внутренних проектов Node.js с несогласованными стилями интерфейсов API можно установить правила, обеспечивающие соблюдение спецификации формата путей для RESTful API, требующие стандартизации процесса обработки ошибок и запрещающие использование console.logпереход к обязательному использованию единого хранилища логов.

Сценарий 4: Безопасность и соответствие нормативным требованиям

• эффект: Помогает предотвратить распространенные нарушения безопасности и соответствовать отраслевым требованиям.
• инструкцииБезопасность кода - краеугольный камень успеха проекта. Для распространенных рисков безопасности, таких как SQL-инъекции, атаки межсайтового скриптинга (XSS) и т. д., в Trae Rules можно настроить правила, которые помогут их предотвратить. Например, запретить встраивание строк SQL-запросов непосредственно в код (заставляя использовать параметризованные запросы или ORM), обнаружить прямой вывод в HTML без достаточного экранирования пользовательского ввода (для предотвращения XSS-атак), а также запретить использование eval() возможно new Function() Правила Trae помогут обнаружить включение в код конфиденциальной информации в открытом виде (например, паролей и ключей). В отраслях с жесткими требованиями к защите данных и аудиту соответствия, таких как финансы и здравоохранение, Trae Rules поможет обнаружить, содержится ли конфиденциальная информация (например, пароли и ключи) в открытом тексте в коде, принудительно зашифровать хранение конфиденциальных данных, таких как пароли, и гарантировать, что логи не содержат персонально идентифицируемой информации (PII), тем самым помогая проектам соответствовать требованиям проверок соответствия.

Сценарий 5: Оптимизация привычек личного развития

• эффект: Помогают разработчикам поддерживать последовательность в их личном стиле кодирования и более эффективно изучать и применять возможности новых языков программирования.
• инструкции: Даже в личных проектах поддержание единого стиля кода может помочь повысить эффективность разработки и читаемость кода. Разработчики могут сделать это, установив личные правила. Кроме того, при изучении нового языка программирования (например, Rust, Go, Python) новички легко могут написать код, который не соответствует привычным парадигмам языка или лучшим практикам. Установив правила Trae, например, при разработке на Rust, которые принуждают использовать Result Типы обрабатываются должным образом (прямые звонки запрещены) unwrap() (игнорирование ошибок), принудительная проверка и обработка возвратов функций при разработке на Go, err переменных (что запрещает игнорировать ошибки), или принудительное использование аннотаций типов при разработке на Python и обеспечение их соответствия mypy и другие инструменты проверки типов совместимы, что может эффективно помочь разработчикам развить хорошие привычки кодирования и быстрее понять суть нового языка.

Тщательно настроив и применив правила Trae, можно более точно адаптировать искусственный интеллект к конкретным потребностям и привычкам разработчиков и более органично интегрировать его в ежедневные рабочие процессы разработки, обеспечив по-настоящему эффективное взаимодействие человека и компьютера. Заинтересованные разработчики должны загрузить последнюю версию Trae IDE с официального канала Trae IDE, чтобы самостоятельно оценить эту возможность.