Komentarze w programow Helion, CNC i EdgeCAM
[ Pobierz całość w formacie PDF ]
//-->Tytuł oryginału: Clean Code: A Handbook of Agile Software CraftsmanshipTłumaczenie: Paweł GoneraProjekt okładki: Mateusz Obarek, Maciej PokońskiISBN: 978-83-283-0234-1Authorized translation from the English language edition, entitled: Clean Code: A Handbook of AgileSoftware Craftsmanship, First Edition, ISBN 0132350882, by Robert C. Martin, published by PearsonEducation, Inc., publishing as Prentice Hall.Copyright © 2009 by Pearson Education, Inc.Polish language edition published by Helion S.A.Copyright © 2014.All rights reserved. No part of this book may be reproduced or transmitted in any form or by any means,electronic or mechanical, including photocopying, recording or by any information storage retrieval system,without permission from Pearson Education Inc.Wszelkie prawa zastrzeżone. Nieautoryzowane rozpowszechnianie całości lub fragmentu niniejszejpublikacji w jakiejkolwiek postaci jest zabronione. Wykonywanie kopii metodą kserograficzną,fotograficzną, a także kopiowanie książki na nośniku filmowym, magnetycznym lub innym powodujenaruszenie praw autorskich niniejszej publikacji.Wszystkie znaki występujące w tekście są zastrzeżonymi znakami firmowymi bądź towarowymi ichwłaścicieli.Autor oraz Wydawnictwo HELION dołożyli wszelkich starań, by zawartew tej książce informacje były kompletne i rzetelne. Nie biorą jednak żadnej odpowiedzialności ani za ichwykorzystanie, ani za związane z tym ewentualne naruszenie praw patentowych lub autorskich. Autor orazWydawnictwo HELION nie ponoszą również żadnej odpowiedzialności za ewentualne szkody wynikłez wykorzystania informacji zawartych w książce.Materiały graficzne na okładce zostały wykorzystane za zgodą iStockPhoto Inc.Wydawnictwo HELIONul. Kościuszki 1c, 44-100 GLIWICEtel. 32 231 22 19, 32 230 98 63e-mail: helion@helion.plDrogi Czytelniku!Jeżeli chcesz ocenić tę książkę, zajrzyj pod adresMożesz tam wpisać swoje uwagi, spostrzeżenia, recenzję.Pliki z przykładami omawianymi w książce można znaleźć pod adresem:ftp://ftp.helion.pl/przyklady/czykov.zipPrinted in Poland.•Kup książkę•Poleć książkę•Oceń książkę•Księgarnia internetowa•Lubię to! » Nasza społecznośćSPIS TREŚCISłowo wstępneWstęp1. Czysty kodNiech stanie się kod...W poszukiwaniu doskonałego kodu...Całkowity koszt bałaganuRozpoczęcie wielkiej zmiany projektuPostawaNajwiększa zagadkaSztuka czystego kodu?Co to jest czysty kod?Szkoły myśleniaJesteśmy autoramiZasada skautówPoprzednik i zasadyZakończenieBibliografia13192324242526272828283435363636372. Znaczące nazwyWstępUżywaj nazw przedstawiających intencjeUnikanie dezinformacjiTworzenie wyraźnych różnicTworzenie nazw, które można wymówićKorzystanie z nazw łatwych do wyszukaniaUnikanie kodowaniaNotacja węgierskaPrzedrostki składnikówInterfejsy i implementacjeUnikanie odwzorowania mentalnegoNazwy klasNazwy metodNie bądź dowcipnyWybieraj jedno słowo na pojęcieNie twórz kalamburów!Korzystanie z nazw dziedziny rozwiązaniaKorzystanie z nazw dziedziny problemuDodanie znaczącego kontekstuNie należy dodawać nadmiarowego kontekstuSłowo końcowe393940414243444545464647474748484949495051525Kup książkęPoleć książkę3. FunkcjeMałe funkcje!Bloki i wcięciaWykonuj jedną czynnośćSekcje wewnątrz funkcjiJeden poziom abstrakcji w funkcjiCzytanie kodu od góry do dołu — zasada zstępującaInstrukcje switchKorzystanie z nazw opisowychArgumenty funkcjiCzęsto stosowane funkcje jednoargumentoweArgumenty znacznikoweFunkcje dwuargumentoweFunkcje trzyargumentoweArgumenty obiektoweListy argumentówCzasowniki i słowa kluczoweUnikanie efektów ubocznychArgumenty wyjścioweRozdzielanie poleceń i zapytańStosowanie wyjątków zamiast zwracania kodów błędówWyodrębnienie bloków try-catchObsługa błędów jest jedną operacjąPrzyciąganie zależności w Error.javaNie powtarzaj sięProgramowanie strukturalneJak pisać takie funkcje?ZakończenieSetupTeardownIncluderBibliografia5356575758585859616262636364646565656667676869696970707171734. KomentarzeKomentarze nie są szminką dla złego koduCzytelny kod nie wymaga komentarzyDobre komentarzeKomentarze prawneKomentarze informacyjneWyjaśnianie zamierzeńWyjaśnianieOstrzeżenia o konsekwencjachKomentarze TODOWzmocnienieKomentarze Javadoc w publicznym APIZłe komentarzeBełkotPowtarzające się komentarzeMylące komentarzeKomentarze wymaganeKomentarze dziennika7577777777787879808081818181828485856SPIS TREŚCIKup książkęPoleć książkęKomentarze wprowadzające szum informacyjnyPrzerażający szumNie używaj komentarzy, jeżeli można użyć funkcji lub zmiennejZnaczniki pozycjiKomentarze w klamrach zamykającychAtrybuty i dopiskiZakomentowany kodKomentarze HTMLInformacje nielokalneNadmiar informacjiNieoczywiste połączeniaNagłówki funkcjiKomentarze Javadoc w niepublicznym kodziePrzykładBibliografia8687888888898990919191929292955. FormatowaniePrzeznaczenie formatowaniaFormatowanie pionoweMetafora gazetyPionowe odstępy pomiędzy segmentami koduGęstość pionowaOdległość pionowaUporządkowanie pionoweFormatowanie poziomePoziome odstępy i gęstośćRozmieszczenie poziomeWcięciaPuste zakresyZasady zespołoweZasady formatowania wujka Boba97989899991011011051061061071091101101116. Obiekty i struktury danychAbstrakcja danychAntysymetria danych i obiektówPrawo DemeterWraki pociągówHybrydyUkrywanie strukturyObiekty transferu danychActive RecordZakończenieBibliografia1131131151171181181191191201211217. Obsługa błędówUżycie wyjątków zamiast kodów powrotuRozpoczynanie od pisania instrukcji try-catch-finallyUżycie niekontrolowanych wyjątkówDostarczanie kontekstu za pomocą wyjątkówDefiniowanie klas wyjątków w zależności od potrzeb wywołującego123124125126127127SPIS TREŚCI7Kup książkęPoleć książkę
[ Pobierz całość w formacie PDF ]