Cześć, mam głupie pytanie , ale mam w metodzie podany parametr który prowadzi do klasy z getterami i setterami. Jak w mogę opisać w komentarzy @param ten parametr żeby był sensowny i osoba nie znająca kodu wiedziała do z kad ten parametr się wziął ?
Co? Podaj coś bardziej konkretnego, bo na razie mogę powiedzieć Ci tyle że jak masz metodę setAge to niech parametr nazywa się age, a jak masz metodę która przyjmuje jak parametr strukturę z danymi logowania, to niech się nazywa loginData, typ odpowiednio do struktury.
Chodzi mi o to ze mam zrobic dokumentacje kodu.
@param klasaX <- i jak mogę opisać ten parametr żeby któś wiedział co on robi?
np. metodaA( KlasaX klasaX){
.....}
i
public class KlasaX{
getA
setA
......
}
Ja
Użyj wiedzy domenowej.
Czy ty sobie robisz jaja? Bo nie wiem czy kasować ten temat za trolling czy tylko przenieść do perełek...
Opisz ten parametr tak zeby każdy wiedział co on robi i już. Ja na przykład nie wiem. Nazwa KlasaX
nic mi nie mówi, tak samo nazwa pola tej klasy a
.
Ok, już doszedłem sam do tego. Faktycznie zle trochę wszytko opisałem. Mozna skaskowac ten post bo jest bez sensu :)