documenting-rust-code

Umiejętność Claude'a, która prowadzi Cię przez najlepsze praktyki dokumentowania kodu Rust w projekcie HASH. Otrzymujesz konkretne reguły dla komentarzy dokumentacyjnych, sekcji błędów, linków wewnętrznych i konwencji rustdoc. Narzędzie aktywuje się automatycznie, gdy piszesz dokumentację funkcji, typów, cech lub modułów, i podpowiada, co robić i czego unikać — od jednoliniowych podsumowań po przykłady i referencje do biblioteki standardowej.

1. 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.
2. 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.
3. Dla funkcji z parametrami użyj opisów wbudowanych w tekst główny zamiast osobnych sekcji # Returns — umiejętność przypomni Ci o tej konwencji.
4. Gdy dokumentujesz funkcje, które mogą zwrócić błąd, dodaj sekcję # Errors z listą możliwych warunków błędu i linkami do typów błędów (np. [NotFound]: EntityError::NotFound).
5. Dodaj praktyczne przykłady dla publicznych API — umiejętność wskaże, kiedy są niezbędne i jak je strukturować.
6. 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.