D
documenting-rust-code
Rust documentation practices for HASH codebase. Use when writing doc comments, documenting functions/types/traits/modules, creating error sections, using intra-doc links, or following rustdoc conventions.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Rust documentation practices for HASH codebase. Use when writing doc comments, documenting functions/types/traits/modules, creating error sections, using intra-doc links, or following rustdoc conventions.
How to use
- Aktywuj umiejętność w Claude'a, gdy pracujesz nad dokumentacją kodu Rust w projekcie HASH — wystarczy wspomnieć o pisaniu doc comment, rustdoc lub dokumentowaniu funkcji/typów/modułów.
- Zanim napiszesz komentarz dokumentacyjny, przeczytaj wskazówkę umiejętności: zacznij od jednoliniowego podsumowania, użyj linków wewnętrznych dla referencji typów (np. [
Vec], [HashMap]) i dokumentuj wszystkie warunki błędu sekcją# Errors. - Dla funkcji z parametrami użyj opisów wbudowanych w tekst główny zamiast osobnych sekcji
# Returns— umiejętność przypomni Ci o tej konwencji. - Gdy dokumentujesz funkcje, które mogą zwrócić błąd, dodaj sekcję
# Errorsz listą możliwych warunków błędu i linkami do typów błędów (np. [NotFound]: EntityError::NotFound). - Dodaj praktyczne przykłady dla publicznych API — umiejętność wskaże, kiedy są niezbędne i jak je strukturować.
- Unikaj dokumentowania standardowych implementacji cech (Debug, Display, From) i komentarzy na tej samej linii co kod — umiejętność będzie Cię ostrzegać o tych błędach.