Szukam pouczającego formatu dokumentacji klas dla moich klas Entity, Business Logic i Data Access. Znalazłem następujące dwa formaty stąd Format 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> ///...
Piszę dużo kodu (głównie c ++ i javascript), który dotyczy geometrii obliczeniowej i grafiki oraz tego rodzaju tematów, więc odkryłem, że diagramy wizualne są nieodzowną częścią procesu rozwiązywania problemów. Właśnie ustaliłem, że „och, czy nie byłoby po prostu fantastycznie, gdybym mógł jakoś...
Rozważ znaczniki konfliktu. to znaczy: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD W szczególnym przypadku, który zmotywował mnie do opublikowania tego pytania, odpowiedzialny członek zespołu właśnie zakończył scalenie z wyższego...
Dokonujemy refaktoryzacji do 20-letniej bazy kodu starszego typu i rozmawiam z kolegą na temat formatu komentarzy w kodzie (plsql, java). Nie ma domyślnego formatu komentarzy, ale w większości przypadków ludzie robią coś takiego w komentarzu: // date (year, year-month, yyyy-mm-dd, dd/mm/yyyy),...
Zamknięte . To pytanie jest oparte na opiniach . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby można było na nie odpowiedzieć faktami i cytatami, edytując ten post . Zamknięte 4 lata temu . W przypadku komentarzy...
Czy to dobry styl, aby używać dodatkowych, zbędnych technicznie zmiennych lokalnych, aby opisać, co się dzieje? Na przykład: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Jeśli chodzi o narzut techniczny, oczekuję, że...
Mam dość dużą prywatną bazę kodów, która ewoluowała od około dziesięciu lat. Nie używam phpDocumentor, ale odkąd używanie sekcji docblock stało się całkiem standardem w projektach open source, zaadaptowałem pisanie docblocków dla wszystkich metod publicznych w moim repozytorium. Większość bloków...
Pracuję nad projektem „kodu spaghetti” i podczas gdy naprawiam błędy i wdrażam nowe funkcje, robię też pewne refaktoryzacje, aby kod mógł być testowany jednostkowo. Kod jest często tak ściśle powiązany lub skomplikowany, że naprawienie małego błędu spowodowałoby przepisanie wielu klas....
Czy są jakieś powszechne praktyki komentowania wyrażeń regularnych: komentarze wstawiane odnoszące się do innej części RegEx lub komentarze ogólne dla wszystkich
Chciałbym poznać najlepszy sposób dodania komentarza w celu zidentyfikowania przestarzałej klasy w Javie. Czy powinienem usunąć poprzedni komentarz dodany na początku klasy, który pomaga innemu programistowi dowiedzieć się, do czego służy ta klasa, czy powinienem dodać go pod...
Rozmawiałem dziś z kolegą. Pracujemy nad kodem dla dwóch różnych projektów. W moim przypadku jestem jedyną osobą pracującą nad moim kodem; w jej przypadku wiele osób pracuje na tej samej bazie kodu, w tym studenci kooperacyjni, którzy przychodzą i odchodzą dość regularnie (co 8-12 miesięcy)....
Kiedy piszę dla siebie małe skrypty, układam swój kod wysoko w stos z komentarzami (czasami komentuję więcej niż koduję). Wiele osób, z którymi rozmawiam, mówi, że powinienem dokumentować te skrypty, nawet jeśli są one osobiste, więc jeśli kiedykolwiek je sprzedam, będę gotowy. Ale czy komentarze...
Jestem zwolenniczką odpowiednio udokumentowanego kodu i doskonale zdaję sobie sprawę z jego wad . To nie wchodzi w zakres tego pytania. Lubię przestrzegać zasady dodawania komentarzy XML dla każdego członka publicznego, biorąc pod uwagę, jak bardzo lubię IntelliSense w Visual Studio. Jest jednak...
Kiedyś byłem fanem wymagania komentarzy XML do dokumentacji. Od tego czasu zmieniłem zdanie z dwóch głównych powodów: Podobnie jak dobry kod, metody powinny być zrozumiałe. W praktyce większość komentarzy XML to bezużyteczny szum, który nie zapewnia żadnej dodatkowej wartości. Wiele razy...
Czy dobrą praktyką jest pisanie komentarzy do powszechnie znanych metod, takich jak równość, porównywanie itp.? Rozważ poniższy kod. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code for...
Mam zamiar opuścić projekt i zanim odejdę, mój szef poprosił mnie o udokumentowanie kodu (nie udokumentowałem zbyt dobrze). To nie jest wielka sprawa, projekt nie jest strasznie skomplikowany. Ale w mojej dokumentacji znajduję miejsca, w których chciałbym powiedzieć: „Zawiadomienie w linii XYZ, że...
To może być głupie pytanie, ale przez jakiś czas było w mojej głowie i nigdzie indziej nie mogę znaleźć porządnej odpowiedzi. Mam nauczyciela, który mówi, że powinniśmy wyraźnie wymienić każdy parametr z opisem, nawet jeśli jest tylko jeden. Prowadzi to do wielu powtórzeń: double MyFunction(const...
Chcę napisać Javadoc w SUCHY sposób. Ale dokument wyroczni o Javadoc mówi, że napisz to samo w komentarzu metody przeciążenia. Czy nie mogę uniknąć
W obecnej formie to pytanie nie pasuje do naszego formatu pytań i odpowiedzi. Oczekujemy, że odpowiedzi poparte będą faktami, referencjami lub wiedzą fachową, ale to pytanie prawdopodobnie będzie wymagało debaty, argumentów, ankiet lub rozszerzonej dyskusji. Jeśli uważasz, że to...
Czytam Clean Code autorstwa Roberta C. Martina, a wyrażenie w TILTniewytłumaczalny sposób pojawia się w niektórych przykładach kodu. Przykład (nawiasem mówiąc, jest w Javie): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return "";...