Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

api-docs

/api-docs

Dodaje i recenzuje komentarze dokumentacyjne XML w C# dla publicznych API SkiaSharp: dokumentowanie klas i członków, uzupełnianie braków i poprawianie błędnych przykładów.

Repozytorium
SkiaSharp ↗
Licencja
MIT
Ostatnia zmiana repozytorium
27.10.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
8
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 27.10.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Dodaje i recenzuje komentarze dokumentacyjne XML w C# dla publicznych API SkiaSharp: dokumentowanie klas i członków, uzupełnianie braków i poprawianie błędnych przykładów.

Oryginalny opis (EN)

Add and review C# XML documentation comments for SkiaSharp public APIs. Use for documenting a class or member, filling missing API docs, reviewing public API documentation, or correcting inaccurate API examples.

Jak działa

  1. Scope and procedure
  2. API-documentation contract
  3. References
  4. Boundaries
Sekcje z nagłówków SKILL.md, w oryginale · 75 linii, 481 słów
Podgląd SKILL.md
---
name: api-docs
description: >
  Add and review C# XML documentation comments for SkiaSharp public APIs. Use
  for documenting a class or member, filling missing API docs, reviewing public
  API documentation, or correcting inaccurate API examples.
metadata:
  layer: router
---

# API Documentation

Write and review the public API prose that `mono/SkiaSharp` owns. C# `///`
comments on public declarations are authoritative. Managed builds generate
compiler XML from those comments and package it beside the managed assemblies.

This repository has no API-reference ECMA/mdoc source, mdoc engine, `docs`
submodule, XML-editing workflow, or placeholder-writing workflow.
`mono/SkiaSharp-API-docs` independently consumes package/compiler XML and
`_DocsMedia`, produces ECMA/mdoc, preserves deferred Uno output, validates,
and publishes Learn. Do not edit that repository or generated output here.

## Scope and procedure

1. Resolve the consumer-visible public types and members in scope. Read their
   declarations and implementations in `binding/` or `source/` before writing
   any prose. Implementation-assembly XML does not make an API public.
2. Add or correct accurate `///` comments immediately above public
   declarations. Work from the source declaration, never from compiler XML.
3. Generated bindings are source-controlled. Edit only their `///` comment
   trivia directly, then run `pwsh -NoLogo -NoProfile -File
   ./utils/generate.ps1` and verify it preserves the intended comments. Never
   manually change generated declarations, interop code, or implementation.
4. Follow [`references/adding.md`](references/adding.md) for source-first
   authoring or [`references/reviewing.md`](references/reviewing.md) for a
   source-first review. Apply the detailed syntax and prose rules in
   [`references/patterns.md`](references/patterns.md).
5. Refresh documentation-convention knowledge from the first-party sources
   listed in [`references/patterns.md`](references/patterns.md) before a
   broad authoring or review pass. Reconcile a changed official convention
   with existing source forms and external rendering before applying it; do
   not mechanically rewrite source comments merely to match a style rule.
6. Verify SkiaSharp and HarfBuzzSharp facts in
   [`references/skia-patterns.md`](references/skia-patterns.md), and ensure
   examples avoid error-obsolete APIs with
   [`references/obsolete-api-map.md`](references/obsolete-api-map.md).
7. Classify findings with [`references/checklist.md`](references/checklist.md)
   and perform the build, compiler-XML, and package checks in
   [`references/validation.md`](references/validation.md).

## API-documentation contract

- The compiler XML generated from public `///` comments is packaged beside the
  corresponding managed assemblies in both `lib/<tfm>` and `ref/<tfm>`.
- The XML beside the reference assembly is the consumer-visible documentation
  contract. The copy beside `lib` is intentional but implementation-only XML
  entries do not expand the public API surface.
- `_DocsMedia` is versioned source in this repository and a nonshipping
  transport artifact. The external API-docs repository retrieves matching
  package and media inputs and owns downstream ECMA/mdoc generation,
  validation, and publication.

## References

| Need | Read |
|---|---|
| Adding or updating source comments | [`references/adding.md`](references/adding.md) |
| Reviewing documentation and examples | [`references/reviewing.md`](references/reviewing.md) |
| C# XML-comment syntax and conventions | [`references/patterns.md`](references/patterns.md) |
| Severity bar and reporting | [`references/checklist.md`](references/checklist.md) |
| Build, compiler-XML, and package validation | [`references/validation.md`](references/validation.md) |
| SkiaSharp/HarfBuzzSharp factual sources | [`references/skia-patterns.md`](references/skia-patterns.md) |
| Error-obsolete API replacements | [`references/obsolete-api-map.md`](references/obsolete-api-map.md) |

## Boundaries

- Do not manually edit compiler-generated XML or ECMA/mdoc files. In generated
  bindings, edit only source-controlled `///` comment trivia and verify a
  generator round trip preserves it.
- Do not remove valid public source comments to defer documentation elsewhere.
  Missing or inaccurate public documentation blocks API review.
- Do not claim defaults, validation, ownership, threading, native layout, or
  standards behavior without verifying the relevant source.
Pliki w paczce (8)
  • SKILL.md 4 KB
  • references/adding.md 4 KB
  • references/checklist.md 3 KB
  • references/obsolete-api-map.md 5 KB
  • references/patterns.md 19 KB
  • references/reviewing.md 5 KB
  • references/skia-patterns.md 8 KB
  • references/validation.md 3 KB

Wersje

RepozytoriumWynikLicencja
Ta strona · mono/SkiaSharp100MIT
Kuan-AI-com/agent-skills100MIT
omnigent-ai/omnigent100Apache-2.0
meyshad/skillforge100MIT
Sun-Lab-NBB/ataraxis100Apache-2.0
zjunlp/skills100MIT

Migawka bazy z 13.11.2026 · wersja paczki a8074329974f (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100writing-xml-doc-comments
    Pisze i przegląda komentarze dokumentacyjne XML w C# dla publicznego API, z opisem parametrów i wartości zwracanych.
  • 100documentation
    Stosuje standardy dokumentacji przy zmianach kodu: pisze i przegląda dokumentację, docstringi i komentarze, opisuje publiczne API i zmiany widoczne dla użytkownika oraz poprawia README.
  • 100code-documentation
    Pomaga pisać dokumentację kodu: README, dokumentację API, komentarze i przewodniki dla programistów.
  • 100docs
    Podaje wytyczne dotyczące dokumentacji projektu: README, CHANGELOG, CONTRIBUTING, ADR, format Keep a Changelog, komentarze dokumentacyjne i dokumentacja API.
  • 100generating-api-docs
    Tworzy dokumentację API z przykładami, przewodnikami uwierzytelniania i SDK.
  • 100generating-api-docs
    Tworzy dokumentację API z przykładami, przewodnikami uwierzytelniania i SDK.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.