스킬 global-commenting
💬

global-commenting

안전 🌐 네트워크 접근📁 파일 시스템 액세스

اكتب تعليقات برمجية نظيفة ومركزة

또한 다음에서 사용할 수 있습니다: DevanB

التعليقات السيئة أو القديمة تخلق الارتباك والديون التقنية. توفر هذه المهارة إرشادات واضحة لكتابة التعليقات التي تشرح لماذا تم اتخاذ القرارات، مما يساعد المطورين على إنشاء كود توثيقي ذاتي يبقى ذا صلة مع مرور الوقت.

지원: Claude Codex Code(CC)
📊 69 적절함
1

스킬 ZIP 다운로드

2

Claude에서 업로드

설정 → 기능 → 스킬 → 스킬 업로드로 이동

3

토글을 켜고 사용 시작

테스트해 보기

"global-commenting" 사용 중입니다. اكتب تعليقاً لدالة الفرز

예상 결과:

  • • اشرح لماذا تم اختيار الفرز السريع بدلاً من دمج الفرز (استخدام الذاكرة في المكان)
  • • وثق استراتيجية اختيار المحور
  • • لاحظ الحالات الخاصة التي يتم التعامل معها
  • • تجنب وصف ما هو الفرز السريع - القراء يعرفون الخوارزمية

보안 감사

안전
v5 • 1/17/2026

Pure documentation skill containing only markdown files with commenting guidelines. No executable code, network access, filesystem operations, or command execution. All 24 static findings are false positives from over-aggressive pattern matching on Git metadata, documentation references, and benign terminology.

2
스캔된 파일
30
분석된 줄 수
2
발견 사항
5
총 감사 수

위험 요인

🌐 네트워크 접근 (1)
📁 파일 시스템 액세스 (4)
감사자: claude 감사 이력 보기 →

품질 점수

38
아키텍처
100
유지보수성
85
콘텐츠
19
커뮤니티
100
보안
91
사양 준수

만들 수 있는 것

كتابة تعليقات واضحة

أضف تعليقات ذات معنى تشرح المنطق المعقد والقرارات غير الواضحة في قاعدة الكود الخاصة بك.

تحسين التوثيق

راجع وحسن التعليقات الموجودة من حيث الوضوح والملاءمة أثناء مراجعات الكود.

توثيق واجهات برمجة التطبيقات

أنشئ سلاسل وثائق متسقة وتعليقات واجهات برمجة التطبيقات باتباع المعايير المعتمدة.

이 프롬프트를 사용해 보세요

إضافة تعليق دالة
أضف تعليقاً واضحاً إلى هذه الدالة الذي يشرح لماذا تم اختيار هذا النهج، مع التركيز على منطق الأعمال وأي قرارات غير واضحة.
مراجعة التعليقات الموجودة
راجع هذه التعليقات وحدد أي منها قديم أو متكرر أو يمكن استبداله بكود أكثر وضوحاً أو أسماء متغيرات.
توثيق الخوارزمية
اكتب تعليقاً يشرح نهج الخوارزمية ولماذا يحل هذه المشكلة بشكل أفضل من البدائل.
تحسين التوثيق الذاتي
اقترح كيفية جعل هذا الكود أكثر وضوحاً من خلال التسمية والبنية، وأين ستظل التعليقات تضيف قيمة.

모범 사례

  • اشرح لماذا يوجد الكود، وليس ما يفعله
  • فضل التسمية الواضحة والبنية على التعليقات المفرطة
  • حافظ على التعليقات الدائمة - تجنب توثيق الإصلاحات المؤقتة
  • أزل أو حدث التعليقات القديمة عند إعادة الهيكلة

피하기

  • التعليق على الكود الواضح (مثل زيادة عداد)
  • استخدام التعليقات لتعطيل الكود (كتل معلقة)
  • كتابة التعليقات التي تصف التغييرات الأخيرة بدلاً من نية الكود
  • إضافة التعليقات التي ستصبح قديمة مع التغييرات المستقبلية

자주 묻는 질문

ما لغات البرمجة التي تدعمها هذه المهارة؟
جميع اللغات. تنطبق الإرشادات عالمياً على أي ملف كود مصدري.
ما مدى تفصيل التعليقات؟
يجب أن تشرح التعليقات القرارات غير الواضحة. الكود الواضح يحتاج إلى عدد أقل من التعليقات.
هل يمكن لهذه المهارة توليد توثيق واجهات برمجة التطبيقات؟
توفر إرشادات لكتابة سلاسل الوثائق لكنها لا تولد التوثيق تلقائياً.
هل يتم تخزين أو نقل بيانات الكود الخاص بي؟
لا. هذه مهارة تعتمد على الطلبات فقط توفر إرشادات. لا يخرج أي كود من جهازك.
كيف يختلف هذا عن أداة التنسيق؟
توفر هذا توجيهاً مفاهيمياً، وليس تطبيقاً آلياً أو تحليلاً للكود.
هل يجب أن أستخدم التعليقات أو أسماء متغيرات أفضل؟
فضل الكود التوثيقي الذاتي من خلال التسمية. استخدم التعليقات عندما لا يمكن للتسمية نقل النية.

개발자 세부 정보

작성자

EIS-ITS

라이선스

MIT

참조

main

파일 구조

📄 SKILL.md