global-commenting
Пишите понятные комментарии к коду
Плохие комментарии устаревают и скрывают важный проектный замысел. Этот навык помогает Claude, Codex и Claude Code писать лаконичные комментарии, объясняющие неочевидную логику.
Установить с помощью моего Агента
Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу Skill и манифест.
Review the Skillstore skill "global-commenting" from https://skillstore.io/skills/eis-its-global-commenting.md and its manifest at https://skillstore.io/api/skills/eis-its-global-commenting/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Ваш Агент по-прежнему должен показать план и запросить все подтверждения, требуемые политикой безопасности.
Ресурсы для AI-агентов
Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.
Протестировать
Использование «global-commenting». У функции есть комментарий, в котором говорится, что она была изменена во время недавней миграции.
Ожидаемый результат:
Замените его стабильным объяснением инварианта, который ввела миграция.
Использование «global-commenting». Сложная проверка разрешений объединяет роль пользователя, состояние аккаунта и feature flags.
Ожидаемый результат:
- Добавьте короткий комментарий, объясняющий правило доступа.
- Не описывайте каждое условие, если имена уже понятны.
Использование «global-commenting». Ревьюер спрашивает, нужен ли docstring каждому helper.
Ожидаемый результат:
Добавляйте docstrings только там, где вызывающему коду нужна информация о контракте, побочных эффектах или границах.
Аудит безопасности
БезопасноThe static filesystem finding is confirmed because SKILL.md references a parent-directory standards file outside the skill folder. No evidence of prompt injection or other semantic abuse was found in the scanned file, but the external reference makes the effective instructions unaudited.
Пункты проверки возможностей (1)
Это реальные локальные возможности, которые могут ожидаться для этого навыка, поэтому они требуют проверки, но не считаются подтверждённым вредоносным поведением.
Факторы риска
📁 Доступ к файловой системе (1)
Поделиться и цитировать этот отчет
Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.
Копировать ссылку на отчёт
https://skillstore.io/skills/eis-its-global-commenting/audits/10?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportЗначок Markdown
[](https://skillstore.io/skills/eis-its-global-commenting?utm_source=security_passport_badge)Значок HTML
<a href="https://skillstore.io/skills/eis-its-global-commenting?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/eis-its-global-commenting/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Встраиваемая карточка
<iframe src="https://skillstore.io/embed/skills/eis-its-global-commenting.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Академические ссылки (APA · BibTeX · CFF)
Цитата APA
EIS-ITS. (2026). global-commenting security audit report (audit version 10) [Author version unspecified]. Skillstore. https://skillstore.io/skills/eis-its-global-commenting/audits/10Цитата BibTeX
@techreport{eis-its-eis-its-global-commenting-2026,
author = {EIS-ITS},
title = {global-commenting security audit report (audit version 10)},
institution = {Skillstore},
year = {2026},
number = {10},
url = {https://skillstore.io/skills/eis-its-global-commenting/audits/10},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "global-commenting security audit report (audit version 10)"
version: "unspecified"
type: report
authors:
- name: "EIS-ITS"
date-released: "2026-07-09"
url: "https://skillstore.io/skills/eis-its-global-commenting/audits/10"
identifiers:
- type: other
value: "skillstore:eis-its-global-commenting:audit:10"
description: "Skillstore immutable audit report identifier"
Сравнить варианты
2 устанавливаемых вариантовНавык каждого автора остаётся отдельным устанавливаемым вариантом. Рекомендуемый вариант ранжируется по данным Skillstore.
Почему этот вариант первый
devanb-global-commenting
2026-09-09
eis-its-global-commenting
2026-09-09
Оценка Skillstore
Почему такая оценка Достоверность доказательств: ВысокийЧто вы можете построить
Документирование сложной логики
Добавляйте лаконичные комментарии для алгоритмов, бизнес-правил и неочевидных компромиссов.
Улучшение существующих комментариев
Проверяйте комментарии при сопровождении и заменяйте устаревшие заметки устойчивыми объяснениями.
Проверка pull requests
Проверяйте, объясняют ли добавленные комментарии замысел, не дублируя читаемый код.
Попробуйте эти промпты
Проверь этот файл и определи, где комментарии добавили бы устойчивый контекст. Предпочитай лучшие имена или структуру, когда комментарий не нужен.
Проверь существующие комментарии в этом изменении. Перепиши комментарии, которые устарели, временные или сосредоточены на недавних правках.
Добавь комментарии для неочевидных бизнес-правил в этом модуле. Объясни замысел, ограничения и компромиссы, не пересказывая каждую строку.
Проведи аудит качества комментариев в этом компоненте по функциям, классам и API. Предложи лаконичный подход к комментированию для будущих изменений.
Лучшие практики
- Используйте комментарии, чтобы объяснять замысел, ограничения и компромиссы, которые код не может ясно показать.
- Улучшайте имена, структуру и тесты перед добавлением комментариев, которые пересказывают очевидное поведение.
- Делайте комментарии долговечными, избегая дат, истории тикетов и временных заметок о реализации.
Избегать
- Добавление комментариев, которые пересказывают каждую строку простого кода.
- Сохранение комментариев, описывающих старое поведение, недавние исправления или временные обходные решения.
- Использование комментариев, чтобы компенсировать неясные имена или устранимую сложность.