Compétences global-commenting
💬

global-commenting

Sûr 🌐 Accès réseau📁 Accès au système de fichiers

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

Également disponible depuis: DevanB

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

Prend en charge: Claude Codex Code(CC)
📊 69 Adéquat
1

Télécharger le ZIP du skill

2

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

3

Activez et commencez à utiliser

Tester

Utilisation de "global-commenting". اكتب تعليقاً لدالة الفرز

Résultat attendu:

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

Audit de sécurité

Sûr
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
Fichiers analysés
30
Lignes analysées
2
résultats
5
Total des audits

Facteurs de risque

🌐 Accès réseau (1)
skill-report.json:6
📁 Accès au système de fichiers (4)
skill-report.json:6 SKILL.md:29 SKILL.md:29 SKILL.md:29
Audité par: claude Voir l’historique des audits →

Score de qualité

38
Architecture
100
Maintenabilité
85
Contenu
22
Communauté
100
Sécurité
91
Conformité aux spécifications

Ce que vous pouvez construire

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

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

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

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

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

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

Essayez ces prompts

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

Bonnes pratiques

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

Éviter

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

Foire aux questions

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

Détails du développeur

Auteur

EIS-ITS

Licence

MIT

Dépôt

https://github.com/EIS-ITS/vss-cli/tree/main/.claude/skills/global-commenting

Réf

main

Structure de fichiers

📄 SKILL.md