api-docs
Pisz i recenzjonuj dokumentację XML dla SkiaSharp zgodnie ze standardami .NET
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do tworzenia i przeglądu dokumentacji API w formacie XML dla biblioteki SkiaSharp. Automatyzuje pisanie komentarzy triple-slash, walidację składni XML oraz formatowanie dokumentów. Obsługuje wszystkie przestrzenie nazw SkiaSharp, w tym HarfBuzzSharp i moduły Views. Idealny dla deweloperów utrzymujących dokumentację open-source'ową lub pracujących nad API .NET.
Jak używać
Zlokalizuj plik XML odpowiadający typowi, który chcesz dokumentować, w katalogu
docs/SkiaSharpAPI/— każdy typ ma własny plik (np. SKCanvas.xml, SKPaint.xml).Otwórz plik i edytuj sekcje
<Docs>wewnątrz elementu typu, uzupełniając tagi<summary>,<param>,<returns>i<value>zgodnie z wytycznymi w referencjach skill'u.Sprawdź poprawność składni XML — skill zawiera narzędzia do walidacji, które wychwycą błędy przed zatwierdzeniem zmian.
Uruchom polecenie
dotnet cake --target=docs-format-docs, aby zwalidować i sformatować dokumentację w całym projekcie.Jeśli dodałeś nowe API do biblioteki, najpierw zregeneruj pliki XML z zestawów NuGet za pomocą narzędzia
mdoc, aby upewnić się, że wszystkie nowe typy są uwzględnione.Wyślij zmiany jako pull request do repozytorium
mono/SkiaSharp-API-docs— dokumentacja jest przechowywana w submodule Git i wymaga osobnego zatwierdzenia.