Dokumentacja projektu w portfolio

Dokumentacja projektu w portfolio
Lectre
  • Rejestracja:około 10 lat
  • Ostatnio:ponad 6 lat
  • Lokalizacja:Warszawa
  • Postów:293
0

Hej. Jestem na ostatnim etapie tworzenia projektu do portfolio. ~10 kilo kodu, w mojej ocenie dobrego kodu. Nie wiem jak na takie projekty patrzą rekruterzy, czy ktokolwiek kto to czyta i weryfikuje. Mimo, że komentarzy w kodzie praktycznie brak, nazwy metod i pól mówią same za siebie. Mam w głowie dwa pytania:

  1. Czy powinienem przelecieć cały kod i nanieść komentarze? Jeśli tak, to jak szczegółowe?
  2. Jak sporządzić dokumentację/readme dla czytającego?

Myślałem, żeby omówić lub rozrysować drzewko projektu i skupić się na najważniejszych klasach np. fasady. Dodatkowo opisałbym w jaki sposób potencjalnie rozbudowywać projekt.

KA
KA
  • Rejestracja:prawie 12 lat
  • Ostatnio:prawie 5 lat
  • Lokalizacja:Warszawa
  • Postów:1683
1
  1. zrób testy i javadoc to maks

i tak mała szansa że ktoś zajrzy w kod


PROGRAMY NA ZAMÓWIENIE, ZALICZENIA STUDENCKIE, KONFIGURACJA SERWERÓW, SYSTEMÓW I BAZ DANYCH, STRONY INTERNETOWE, POMOC W PROGRAMOWANIU, POPRAWIENIE I OPTYMALIZACJA APLIKACJI
JAVA, C++, LINUX, WWW, SQL, PYTHON
POSIADAM KOMERCYJNE DOŚWIADCZENIE
TANIO, SZYBKO I PORZĄDNIE
Z KOMENTARZAMI OBJAŚNIAJĄCYMI KOD
PISZ NA PRYWATNĄ WIADOMOŚĆ
CENY JUŻ OD 49,99ZŁ ZA PROGRAM
ZAJMIJ SIĘ TYM CO CIĘ NAPRAWDĘ INTERESUJE!
Lectre
Serio? 70% czasu poprawiałem co tylko się dało, by nie było gdzie się przyczepić :P
KA
wrzuć na github i tutaj nam pokaż
niezdecydowany
niezdecydowany
" by nie było gdzie się przyczepić :P" hueeuheuheu
Lectre
@karolinaa Jak skończę to i tak wrzucę. @niezdecydowany Mam na myśli to, że utrzymuję kod z relatywnie niskim procentem niechlujek :)
LukeJL
  • Rejestracja:około 11 lat
  • Ostatnio:minuta
  • Postów:8414
1

Mimo, że komentarzy w kodzie praktycznie brak, nazwy metod i pól mówią same za siebie.

No i o to chodzi. Komentarze to słabość. Dobry kod to taki, w którym nie ma komentarzy, bo można z kodu się domyślić co kod robi. Nie zawsze da się zrealizować to zadanie w 100% i dlatego czasami trzeba nanieść komentarze.

Tak jak z książkami. Czasem tłumacze/redakcja daje gwiazdkę i na dole "przyp. tłum." albo "przyp. red.", ale nikt na siłę nie leci i nie dodaje tych przypisów (pomijając prace akademickie czy magisterskie, gdzie im więcej przypisuf tym bardziej ęteligętnie XD).


spartanPAGE
AD. przypisów; Rzygać mi się chcę od tekstów, gdzie na stronie jest 25 wygwiazdkowanych (nie numerowanych) przypisów.
NZ
  • Rejestracja:ponad 9 lat
  • Ostatnio:ponad 8 lat
  • Postów:93
0

Pokaż kod.

Shalom
  • Rejestracja:około 21 lat
  • Ostatnio:prawie 3 lata
  • Lokalizacja:Space: the final frontier
  • Postów:26433
1

Nikt nie będzie patrzył na ten kod chyba że wyraźnie w ogłoszeniu mówią że chcą zobaczyć kawalek twojego kodu, ale wtedy też popatrzą na jakieś 2 losowe klasy ;]


"Nie brookliński most, ale przemienić w jasny, nowy dzień najsmutniejszą noc - to jest dopiero coś!"
ZA
  • Rejestracja:prawie 12 lat
  • Ostatnio:ponad 6 lat
  • Lokalizacja:Wro
0

jesli masz doswiadczenie zawodowe i nie bylo nigdzie napisane abys przygotowal projekt to nikt tam nawet nie zagladnie. Beda sie ciebie dopytywac o projekty komercyjne.

Lectre
  • Rejestracja:około 10 lat
  • Ostatnio:ponad 6 lat
  • Lokalizacja:Warszawa
  • Postów:293
0

Gdy przeglądałem tematy innych dot. rozmów kwalifikacyjnych, aplikujący często był przepytywany o swoje projekty. Zasugerowałem się, że firmy raczej wnikliwie przeglądają portfolia, szczególnie gdy ktoś nie ma studiów ani komercyjnego doświadczenia.

KA
KA
  • Rejestracja:prawie 12 lat
  • Ostatnio:prawie 5 lat
  • Lokalizacja:Warszawa
  • Postów:1683
1
Lectre napisał(a):

Jestem na ostatnim etapie tworzenia projektu do portfolio. (...) ~10 kilo kodu, w mojej ocenie dobrego kodu. (...)
70% czasu poprawiałem co tylko się dało, by nie było gdzie się przyczepić :P

Shalom napisał(a):

Nikt nie będzie patrzył na ten kod chyba że wyraźnie w ogłoszeniu mówią że chcą zobaczyć kawalek twojego kodu, ale wtedy też popatrzą na jakieś 2 losowe klasy ;]


PROGRAMY NA ZAMÓWIENIE, ZALICZENIA STUDENCKIE, KONFIGURACJA SERWERÓW, SYSTEMÓW I BAZ DANYCH, STRONY INTERNETOWE, POMOC W PROGRAMOWANIU, POPRAWIENIE I OPTYMALIZACJA APLIKACJI
JAVA, C++, LINUX, WWW, SQL, PYTHON
POSIADAM KOMERCYJNE DOŚWIADCZENIE
TANIO, SZYBKO I PORZĄDNIE
Z KOMENTARZAMI OBJAŚNIAJĄCYMI KOD
PISZ NA PRYWATNĄ WIADOMOŚĆ
CENY JUŻ OD 49,99ZŁ ZA PROGRAM
ZAJMIJ SIĘ TYM CO CIĘ NAPRAWDĘ INTERESUJE!
KA
link like "% @niezdecydowany %" :p
Lectre
Dokładnie :D
niezdecydowany
niezdecydowany
  • Rejestracja:ponad 12 lat
  • Ostatnio:ponad 9 lat
  • Lokalizacja:Bieszczady
0

Twój kod zostanie przeanalizowany - ale chyba tylko jak ten kod - to rozwiązanie zadania rekrutacyjnego.
<trocheHejtu>I nie pisze tutaj o jakimś śmiesznym codility (ale #magistry też muszę mieć jakieś szanse, bo przecież potrafią tylko rozwiązywać zadania o żabach albo klepać CRUD'y oparte o servlety)</trocheHejtu>


"Perhaps surprisingly, concurrent programming isn’t so much about threads or
locks, any more than civil engineering is about rivets and I-beams."
edytowany 1x, ostatnio: niezdecydowany
katecpp
  • Rejestracja:ponad 9 lat
  • Ostatnio:12 miesięcy
  • Postów:27
0

Moim zdaniem nie ma sensu nanosić komentarzy ani robić dokumentacji. Nie zgadzam się jednak z tym, że nikt do kodu nie zajrzy. Zależy od firmy. Jeśli nie składasz CV do korpo gdzie tygodniowo mielone jest kilka, kilkanaście aplikacji lub więcej, tylko do mniejszej firmy, to szanse na to że ktoś jednak kod przejrzy rosną. Z doświadczenia wiem że istnieje przynajmniej jedna firma, w której kod udostępniony przez kandydata jest analizowany. :) Oczywiście nie jest to jakaś dogłębna analiza, tylko raczej max. kilkunastominutowe pobieżne oglądanie. Jednak pozwala to wysnuć jakieś wnioski o kandydacie.

Lectre
Kilkunastominutowa analiza nadal brzmi lepiej niż obejrzenie dwóch klas :D
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)