Dokumentacja projektu w portfolio

Odpowiedz Nowy wątek
2015-09-12 19:04
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.

Pozostało 580 znaków

2015-09-12 20:04
1

2) 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!
Serio? 70% czasu poprawiałem co tylko się dało, by nie było gdzie się przyczepić :P - Lectre 2015-09-12 20:24
wrzuć na github i tutaj nam pokaż - karolinaa 2015-09-12 20:37
" by nie było gdzie się przyczepić :P" hueeuheuheu - niezdecydowany 2015-09-12 20:38
@karolinaa Jak skończę to i tak wrzucę. @niezdecydowany Mam na myśli to, że utrzymuję kod z relatywnie niskim procentem niechlujek :) - Lectre 2015-09-12 21:26

Pozostało 580 znaków

2015-09-12 21:01
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).


((0b10*0b11*(0b10**0b101-0b10)**0b10+0b110)**0b10+(100-1)**0b10+0x10-1).toString(0b10**0b101+0b100);
AD. przypisów; Rzygać mi się chcę od tekstów, gdzie na stronie jest 25 wygwiazdkowanych (nie numerowanych) przypisów. - spartanPAGE 2015-09-12 21:13

Pozostało 580 znaków

2015-09-12 21:19
nz
0

Pokaż kod.

Pozostało 580 znaków

2015-09-12 21:41
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 ;]


Masz problem? Pisz na forum, nie do mnie. Nie masz problemów? Kup komputer...

Pozostało 580 znaków

2015-09-12 21:58
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.

Pozostało 580 znaków

2015-09-12 22:00
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.

Pozostało 580 znaków

2015-09-12 22:05
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!
Dokładnie :D - Lectre 2015-09-12 22:13

Pozostało 580 znaków

2015-09-12 22:42
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, 2015-09-12 22:43

Pozostało 580 znaków

2015-09-14 19:20
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.

Kilkunastominutowa analiza nadal brzmi lepiej niż obejrzenie dwóch klas :D - Lectre 2015-09-14 19:22

Pozostało 580 znaków

Odpowiedz
Liczba odpowiedzi na stronę

1 użytkowników online, w tym zalogowanych: 0, gości: 1, botów: 0