Analiza kodu źródłowego programów

Analiza kodu źródłowego programów
robcio
  • Rejestracja:prawie 13 lat
  • Ostatnio:ponad 10 lat
  • Lokalizacja:Opole
  • Postów:533
1

Mam sobie np jakiś projekt w javie który jest przykładowym programem ukazującym możliwości biblioteki. Jest on dosyć duży. Moje pytanie brzmi jak analizować taki program aby dowiedzieć się jak działają wszystkie mechanizmy biblioteki aby móc je potem używać. Jest tam dosyć dużo metod i trudno się w tym połapać. Zaczynać analizę od maina? później wyłonić najważniejsze klasy i to je analizować w celu znalezienia klas z których one korzystają czy jak. Wiem ,że to może troche głupie pytanie, ale ja bym się chciał dowiedzieć jak wy postępujecie jak byście mieli analizować cudzy kod źródłowy. Proszę o wskazówki.


Nie odpowiadam na PW z prośbą o pomoc programistyczną.
Patryk27
Moderator
  • Rejestracja:ponad 17 lat
  • Ostatnio:ponad rok
  • Lokalizacja:Wrocław
  • Postów:13042
4

Ja zacząłbym od przeczytania dokumentacji kodu...


edytowany 1x, ostatnio: Patryk27
Endrju
Dobra odpowiedź.
n0name_l
dopoki do kodu bedzie dolaczona dokumentacja...
n0name_l
  • Rejestracja:ponad 12 lat
  • Ostatnio:ponad 4 lata
  • Postów:2412
1

Jesli jest to duzy kod to calosc bedzie ciezko ogarnac, ogolnie to ja robie prawie zawsze tak samo:

  1. szukam dokumentacji / komentarczy czegokolwiek co mogloby naprowadzic.
  2. sprawdzam moduly i mniej wiecej co one robia (organizacja kodu)
  3. lece od maina badajac jakas sciezke wykonania
  4. sprawdzam pozostale przypadki

Dodam tylko, ze analiza calego kodu czesto jest nie potrzebna, poniewaz:
a) do bibliotek powinna byc dolaczona dokumentacja (albo szukamy tego co nas w niej interesuje)
b) jesli musimy ogarnac jakis kod firmowy (jestesmy nowymi pracownikami) to robi sie to raczej powoli, a i tak sie zapamieta
c) zazwyczaj jest sprawdzana konkretna funkcjonalnosc (jak zostala zaimplementowana, etc.)

pythonpythonpythonpython
  • Rejestracja:prawie 12 lat
  • Ostatnio:ponad 11 lat
2

Najlepszą analizą kodu jest po prostu użycie go. Wtedy wiesz co jest dobre, a co złe.

1

A co do pytania zadanego przez autora:

  • Jeśli jakaś biblioteka nie ma dokumentacji technicznej - oznacza to, że dana biblioteka jest źle napisana. Mało profesjonalnie i nie wiadomo czy na pewno można jej zaufać. Chyba, że...
  • Jeśli biblioteka nie ma dokumentacji, ale posiada udostępniony szereg testów jednostkowych, to jest to dobra biblioteka, a dokumentacja nie jest potrzebna. Testy jednostkowego, zautomatyzowane i inne są dużo lepsze niż dokumentacja.

W takim przypadku analiza przykładowego kodu nie jest potrzebna, gdyż same testy w sobie są dokumentacją i przykładem wykorzystania kodu.

Jeśli zaś widziałbym bibliotekę gdzie ktoś podaje przykładową aplikację z użyciem tej biblioteki (gdzie brak testów lub chociaż dokumentacji), to nawet nie zawracałbym sobie głowy nią. Zwyczajnie nie ufałbym takiej bibliotece bo bardzo prawdopodobne, że zawiera ona multum błędów.

W takim przypadku dużo lepiej:

  • Napisać własną bibliotekę. Zresztą pisanie to przecież najlepsze co może być u programisty.
  • Szukać innej biblioteki, która nas zadowoli.
edytowany 1x, ostatnio: Shalom
n0name_l
wydaje mi sie, ze ta biblioteka to byl tylko przyklad... Chodzilo raczej o ogolna analize kodu. To zeby przeczytac dokumentacje to raczej autor wie.
Shalom
Pozwoliłem sobie zedytować twój post. Następnym razem będę kasował, nawet jeśli część posta jest wartościowa. Osobiste wycieczki i przezwiska to sobie zachowaj dla kolegów z podwórka.
ludojad
  • Rejestracja:około 17 lat
  • Ostatnio:ponad 11 lat
0

http://www.atlassian.com/software/fisheye/overview/feature-overview

W kontekście analizy kodu może mniej przydatne, gdy już masz projekt, ale gdy tworzysz jakiś od nowa lub chcesz mu się przyjrzeć, przedyskutować w grupie to całkiem mocne narzędzie.


This is not a bug, this is a challenge!
Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)