commenting-c-and-python Skill
Follow bocpy commenting and documentation conventions. Use when: adding comments to C or Python files, writing docstrings, documenting structs or classes, adding Doxygen doc-comments, using Sphinx param style, suppressing linter warnings with noqa, or following flake8 style rules (Q000, D205, D209, N802). Published by microsoft in bocpy.
What is commenting-c-and-python Skill?
Follow bocpy commenting and documentation conventions. Use when: adding comments to C or Python files, writing docstrings, documenting structs or classes, adding Doxygen doc-comments, using Sphinx param style, suppressing linter warnings with noqa, or following flake8 style rules (Q000, D205, D209, N802). Published by microsoft in bocpy. This profile combines repository metadata with install, compatibility, and usage signals so developers can quickly decide whether it fits their agent workflow before opening the source repository.
Automated repository signals based on public metadata such as recency, license, installation evidence, and adoption. These are not a security audit or endorsement.
Key capabilities
- Includes SKILL.md support
- Reusable instructions support
- Documentation
- Writing
- Documentation use cases
- Writing use cases
Technical details
- Install or run with Copy skill directory
When to use commenting-c-and-python Skill
- Use it for documentation.
- Use it for writing.
Built with
Editorial notes
Source
- Creator: microsoft
- Repository: microsoft/bocpy
- Skill file: .github/skills/commenting-c-and-python/SKILL.md
What it does
Follow bocpy commenting and documentation conventions. Use when: adding comments to C or Python files, writing docstrings, documenting structs or classes, adding Doxygen doc-comments, using Sphinx param style, suppressing linter warnings with noqa, or following flake8 style rules (Q000, D205, D209, N802).
Skill instructions
Commenting C and Python Files This skill describes the commenting conventions used across the bocpy project. Follow these patterns when adding or editing comments so the codebase stays consistent. C Files (core.c, math.c) Function-Level Documentation — Doxygen /// Style Every non-trivial function gets a Doxygen doc-comment block immediately above its signature. Use triple-slash /// lines with @ tags in this order: 1. @brief — one-line summary (sentence case, no trailing period) 2. @details — optional longer explanation 3. @note — optional caveats or side-effects 4. @param — one per parameter (description starts uppercase) 5. @return — what the function returns c /// @brief Creates a new BOCTag object from a Python Unicode string /// @details The result object will not be dependent on the argument in any way /// (i.e., it can be safely deallocated). /// @param unicode A PyUnicode object /// @param queue The queue to associate with this tag /// @return a new BOCTag object BOCTag tagfromP
Explore related resources
Frequently asked questions
What is commenting-c-and-python?
commenting-c-and-python is a open-source AI agent skill with Copy skill directory. Follow bocpy commenting and documentation conventions. Use when: adding comments to C or Python files, writing docstrings, documenting structs or classes, adding Doxygen doc-comments, using.
Who is commenting-c-and-python best for?
commenting-c-and-python is best for reusing agent instructions, scripts, and references, documentation workflows, writing workflows.
How do I install commenting-c-and-python?
Install or run commenting-c-and-python using Copy skill directory. Check commenting-c-and-python for the latest setup command.
Is commenting-c-and-python actively maintained?
commenting-c-and-python may need a closer maintenance check before production use.
Auto-fetched from GitHub.
