W ramach tego kroku uporządkujesz kod, dodasz komentarze, wygenerujesz dokumentację kodu
-
Klasa
BigRationalzapisana jest w wielu plikach (klasa częściowa). Przenieś powiązany tematycznie kod metod do odpowiednich plików opisujących dane funkcjonalności. Przykład: parsowanie napisów oraz konwersje do innych typów liczbowych. -
Skoryguj kod stosując technikę łańcuchowania. Dana funkcjonalność powinna być zaprogramowana w jednym miejscu, zaś w wielu innych udostępniasz ją w określony, zestandaryzowany sposób. Przykładem jest przesłonięcie metody
Equals, do której wielokrotnie odwołujesz się, np. przeciążając operatory==,!=czy metody, np.CompareTo(). -
Zastanów się nad optymalizacją kodu i zastosowanych w nim algorytmów.
-
Skoryguj stosowane przez Ciebie nazwy w kodzie. Stosuj wytyczne Microsoft C# Coding Conventions (C# Programming Guide). Pamiętaj, że w C# nazwy parametrów metod mają znaczenie (w przeciwieństwie do innych języków programowania). Użytkownik, korzystający z Twojej klasy i publicznych metod może skorzystać z funkcjonalności argumentów nazwanych Named and Optional Arguments (C# Programming Guide). Zamiast zapisać np.
public BigRational(long num, long denom)lepiej podać:public BigRational(long numerator, long denominator). -
Skomentuj wszystkie publiczne składniki Twojej klasy, stosując domyślny system komentowania dla C# Documenting your code with XML comments.
-
Wygeneruj dokumentację klasy (formalnie projektu typu class library) za pomocą dodatkowego narzędzia - Microsoft proponuje DocFX. Możesz go użyć w wariancie standalone albo jako dodatek NuGet - integrując go z Twoim projektem typu class library. Każdorazowy Build projektu uruchamia proces generowania dokumentacji (przechowywanej w folderze
_siteprojektu), dokumentacja klasy w html znajduje się w_site/api.UWAGA: proces generowania dokumentacji może długo trwać! Weź pod uwagę nagły wzrost zapotrzebowania na pamięć dyskową (nawet w GB) - powstanie wiele plików, również dużych.