Formatowanie kodu

Z Wikipedii, wolnej encyklopedii
Przejdź do nawigacji Przejdź do wyszukiwania

Formatowanie kodu — mniej lub bardziej sformalizowany zestaw reguł i zaleceń określający, jak powinien wyglądać kod źródłowy programu od strony jego czytelności i wyglądu. Wśród obszarów zainteresowania można wyróżnić np. zasady tworzenia wcięć czy nazewnictwo zmiennych i funkcji. Formatowanie kodu nie ma wpływu na sposób interpretacji lub kompilacji programu lecz jest bardzo ważne dla programistów, którzy go rozwijają. Czytelność poszczególnych zasad jest subiektywna, dlatego nie istnieje jedna, uniwersalna konwencja. Ponadto, przyjęte reguły zależą od wybranego języka programowania.

Metryka oprogramowania – miara pewnej własności oprogramowania lub jego specyfikacji. Termin ten nie ma precyzyjnej definicji i może oznaczać właściwie dowolną wartość liczbową charakteryzującą oprogramowanie.Podprogram (inaczej funkcja lub procedura) - termin związany z programowaniem proceduralnym. Podprogram to wydzielona część programu wykonująca jakieś operacje. Podprogramy stosuje się, aby uprościć program główny i zwiększyć czytelność kodu.

W terminologii informatycznej wyróżnia się pojęcie styl kodowania, którym określa się nieformalne zbiory reguł, oraz standard kodowania będący formalnym dokumentem wdrożonym w konkretnym projekcie.

Znaczenie[ | edytuj kod]

W projektach zespołowych jednym z najważniejszych wymienianych powodów stosowania jednolitych reguł formatowania kodu są koszty utrzymania oprogramowania. We wstępie do opisu konwencji kodowania dla języka Java, firma Sun Microsystems wymieniła następujące fakty:

PHP – obiektowy język programowania zaprojektowany do generowania stron internetowych i budowania aplikacji webowych w czasie rzeczywistym.W informatyce przepływ sterowania oznacza kolejność, w jakiej pojedyncze wyrażenia lub instrukcje są wykonywane w paradygmacie programowania imperatywnego. W języku programowania instrukcja przepływu sterowania może zmienić przepływ sterowania tak, aby wyrażenia wykonywane były w innej kolejności, niż ta, w jakiej są wypisane w kodzie źródłowym. Pojęcie przepływu danych jest prawie zawsze ograniczane do pojedynczego wątku aplikacji, ponieważ dotyczy ono wykonywania instrukcji po jednej naraz.
  • 80% kosztów oprogramowania wynosi jego utrzymanie,
  • jedynie nieliczne systemy są rozwijane ciągle przez jeden, niezmienny zespół programistów,
  • konwencje formatowania kodu zwiększają jego czytelność, pozwalając na szybsze wdrożenie nowych inżynierów w prace nad rozwojem oprogramowania,
  • jeśli sprzedajesz kod źródłowy jako produkt, musisz upewnić się, że jest on zaparkowany i czytelny tak, jak w przypadku innych produktów.
  • Sposób formatowania kodu ma także wpływ na niezawodność tworzonego oprogramowania — reguły mogą zabraniać stosowania zapisów, które mogą być mylące dla programistów, a także enigmatycznych nazw.

    camelCase – system notacji ciągów wyrazów, w którym kolejne wyrazy pisze się łącznie, rozpoczynając każde słowo wielką literą. Np. foreColor, setConnection, isPaymentPosted. Zapis camelCase różni się od notacji PascalCase, tym że rozpoczyna się małą literą.Standardy kodowania GNU (The GNU coding standards) to zestaw reguł i wskazówek dotyczących pisania programów komputerowych, które są konsekwentnie stosowane w obrębie systemu GNU. Dokumentacja standardu jest częścią Projektu GNU i jest dostępna na stronie internetowej projektu . Podczas, gdy standard skupiony jest głównie wokół pisania wolnego oprogramowania dla GNU w języku C, większość można zaaplikować ogólnie do oprogramowania. Projekt GNU w szczególności zachęca swoich zwolenników aby zawsze starać się podążać za tymi standardami, niezależnie od tego czy program jest napisany w C. Styl formatowania kodu w C jest szeroko rozpowszechniony w środowisku wolnego oprogramowania. Niezależnie od tego każdy może stosować te wskazówki.

    Formatowanie kodu ma wpływ na dodatkowe narzędzia analizy i przetwarzania kodu źródłowego. Programy takie, jak Doxygen czy javadoc wykorzystują informacje zawarte w komentarzach do generowania dokumentacji. W przypadku metryk oprogramowania bazujących na kodzie źródłowym, stosowanie jednolitej konwencji zwiększa dokładność pomiarów i umożliwia porównywanie poszczególnych fragmentów kodu.

    Definicja intuicyjna: Kod źródłowy to zapis programu komputerowego w formie czytelnej dla człowieka umożliwiający jego modyfikację i rozwój.Tabulacja to sposób wyrównywania tekstu, stosowany w maszynach do pisania, do których nawiązuje zachowanie komputerowych edytorów tekstu.


    Podstrony: 1 [2] [3] [4]




    Warto wiedzieć że... beta

    W programowaniu obiektowym interfejs jest definicją abstrakcyjnego typu posiadającego jedynie operacje, a nie dane. Kiedy w konkretnej klasie zdefiniowane są wszystkie metody interfejsu mówimy, że klasa implementuje dany interfejs. W programie mogą być tworzone zmienne typu referencja do interfejsu, nie można natomiast tworzyć obiektów tego typu. Referencja może wskazywać na obiekt dowolnej klasy implementującej dany interfejs. Interfejs określa udostępniane operacje, nie zawiera natomiast ich implementacji i danych. Z tego powodu klasy mogą implementować wiele interfejsów, bez problemów wynikających z wielokrotnego dziedziczenia. Wszystkie metody w interfejsie z reguły muszą być publiczne.
    Pascal – dawniej jeden z najpopularniejszych języków programowania, uniwersalny, wysokiego poziomu, ogólnego zastosowania, oparty na języku Algol. Został opracowany przez Niklausa Wirtha w 1970 roku. Nazwa języka pochodzi od nazwiska francuskiego fizyka, matematyka i filozofa Blaise Pascala.
    W programowaniu obiektowym klasa jest częściową lub całkowitą definicją dla obiektów. Definicja obejmuje dopuszczalny stan obiektów oraz ich zachowania. Obiekt, który został stworzony na podstawie danej klasy nazywany jest jej instancją. Klasy mogą być typami języka programowania - przykładowo, instancja klasy Owoc będzie mieć typ Owoc. Klasy posiadają zarówno interfejs, jak i strukturę. Interfejs opisuje, jak komunikować się z jej instancjami za pośrednictwem metod, zaś struktura definiuje sposób mapowania stanu obiektu na elementarne atrybuty.
    Doxygen to generator dokumentacji dla języków C++, C, Java, Objective-C, Python, IDL, Fortran i do pewnego stopnia dla PHP, C#, D oraz ActionScript. Obsługuje następujące formaty wyjściowe: HTML, CHM, RTF, PDF, LaTeX, PostScript oraz strony man
    Definicja intuicyjna: Javadoc (wym. "dżawadok") to narzędzie automatycznie generujące dokumentację na podstawie zamieszczonych w kodzie źródłowym znaczników w komentarzach. Javadoc został stworzony specjalnie na potrzeby języka programowania Java przez jego twórców.
    Komentarz – fragment kodu źródłowego, którego jedynym celem istnienia jest informowanie o czymś osoby czytającej źródła, a który nie ma żadnego wpływu na program - i jest zazwyczaj przez kompilator czy też interpreter pomijany.
    Język programowania – zbiór zasad określających, kiedy ciąg symboli tworzy program komputerowy oraz jakie obliczenia opisuje.

    Reklama