Tadeusz Olszewski pisze:
> Użytkownik "Sebastian Biały" <h...@p...onet.pl> napisał w wiadomości
> news:htguq4$ft1$2@news.onet.pl...
>> Adam Kłobukowski wrote:
>>> Podstawa to dobra dokumentacja (nawet zrobiona post napisaniu kodu),
>>> dobre komentarze w kodzie, i jak najmniejsze korzystanie ze staticow ;)
>>
>> Podstawa to kod który sie dokumentuje samą jakością bez potrzeby
>> użycia komentarzy ;)
>
> Ciekawy koncept, może jakieś przykłady?

Prawdopodobnie chodzi o to, że zamiast komentarzy piszesz:

void
BardzoDobrzeNapisanaFunkcjaZeSprytnymAlgorytmemPolec
amGoracoTylkoOdbiorOsobisty()

{
}

Dokumentuje się jakością, nie ma komentarzy. Wszystko jest.

JD

do góry

Jędrzej Dudkiewicz wrote:
>>> Podstawa to kod który sie dokumentuje samą jakością bez potrzeby
>>> użycia komentarzy ;)
>> Ciekawy koncept, może jakieś przykłady?
> Prawdopodobnie chodzi o to, że zamiast komentarzy piszesz:
> void
> BardzoDobrzeNapisanaFunkcjaZeSprytnymAlgorytmemPolec
amGoracoTylkoOdbiorOsobisty()
> {
> }

To w jedną stronę przegięcie.

W drugą jest tak:

void IncreaseByOneViaArgument( int& _value )
{
_value++;
}

I półtorej strony dokumentacji (autentyk).

Po środku jest zdrowy rozsadek. I o niego chodzi.

do góry

bartekltg wrote:
>>Podstawa to kod który sie dokumentuje samą jakością bez potrzeby użycia
>>komentarzy ;)

> Juz ktoryś raz spotykam sie z tym zdaniem. Ale to dziala tylko
> lokalnie.

Całkiem sporo projektów obywa sie bez dokumentacji lub ze szczątkową.
Szczególnie jak są refaktorowane ciągle. Utrzymanie dokumentacji jest
zbędną czynnością o ile jest dyscyplina pisania w sposób zrozumiały w
samym języku. Nie jestem przeciwnikiem dokumentacji, ale nie jestem jej
zwolennikiem dla projektów rozwijanych w locie.

> 'Co tak naprawde robi ta funkcja(i 10 innych w niej wykorzystywanych),
> obiekt, kawal programu i po co' sie samo nie skomentuje, jesli jest
> to
> cos nietrywialnego i dluzszego.

Jesli jest dłuzszego to:

a) masz do czynienia z wiedzą specjalistyczną (typu liczenie FFT) i do
zrozumienia wymagane jest coś poza umiejętnością programowania ogólnego.

b) masz spieprzony kod typu funkcje po 4 ekrany ifów, while i forów na 7
poziomach wycinania.

W pozostałych przypadkach mozna kod pociąć na kawałki, zrobić sensowne
nazwy, sensowne wzorce, pisać zgodnie ze sztuką. Jesli masz nietypowy
projekt to trudno o nim dyskutować ogolnie w tym wątku.

> Co z tego, ze widze ladne liczenia splotu probki z jakas funkcją,
> jesli w komentarzu nie jest napisane po co?

Ta wiedza znajduje sie poziom wyżej w metodzie wołającej to coś. Jesli
jej tam nie ma, to masz problem nawet ze wspomaganiem dokumentacją.

do góry

Maciej Pilichowski wrote:
>>Podstawa to kod który sie dokumentuje samą jakością bez potrzeby użycia
>>komentarzy ;)

> Kurcze, wyprzedziles mnie :-)) A dopowiem tez, ze lubie jezyki, ktore
> jak najwczesniej pozwalaja na kontrole tego co sie z kodem dzieje (np.
> wole jezyki statycznie typowane).

Dodatkowo jeśli robisz normalne Code Review i inni nie rozumeja tego co
napisałeś to przepisujesz tak żeby zrozumieli, do skutku. Silne typy
dają pewne gwarancje co do tego jaki kod jest niżej bez zaglądania (
"aaaa, to tu musi być jakiś logger z metodą print bo implementuje ten
interfejs, ok, więc wystarczy zrobić wrapper na niego").

do góry

> >
>
> Mam wrażenie, że jakiś mglisty ten post...
> Choć jest to wrażenie hmmm... mgliste ?

100% korrekt - przypominają mi sie fajne kawałki becka



--
Wysłano z serwisu OnetNiusy: http://niusy.onet.pl

do góry

> dają pewne gwarancje co do tego jaki kod jest niżej bez zaglądania (
> "aaaa, to tu musi być jakiś logger z metodą print bo implementuje ten
> interfejs, ok, więc wystarczy zrobić wrapper na niego").


Nie byłem pewien czy mój topic zostanie własciwie zrozumiany
ale widze ze został zrozumiany - własnie o to mi chodzi;

obecnie jak mowie klepiac wlasne programy w domenach ktore mam
jako tako otrzaskane (ogolne programowanie, c, winapi czy ogl)
(nie mowie ze cale ale przynajmniej pewne funkcjonalne
podzbiory) nie doswiadczam 'na codzień' tego rodzaju mglistosci,
ale bywalo drzewiej ze siedzac przed duzym blokiem obcego kodu
mozna sie poczuc jak we mgle i przez wiele dni nie mozna za duzo
zrobic tylko siedziec na tylku i starac sie obczajac owa mgle :-/



--
Wysłano z serwisu OnetNiusy: http://niusy.onet.pl

do góry

> Silne typy
> dają pewne gwarancje co do tego jaki kod jest niżej bez zaglądania (
> "aaaa, to tu musi być jakiś logger z metodą print bo implementuje ten
> interfejs, ok, więc wystarczy zrobić wrapper na niego").

b sluszna uwaga

i pewnego rodzaju niskopoziomowe rozwiazania maja tego rodzaju
zakusy (Zeby spieprzyc przejzystosc), np cos co denerwowalo mnie
niemozebnie -> gdzies cos w jakichś funkcjach winapi (nie pamietam
juz gdzie) funkcja potrzebowala by przekazac jej przez wskaznik
jakis obiekt ktory sam mialem utworzyc po swojej stronie
- tylko u diabła nie mialem sie jak dowiedzieć czy moge to
cholerstwo zwolnic czy musze trzymac (tj czy ona to sobie
kopiuje wewnetrznie czy potrzebuje wskaznika na trwajacy obiekt)
- takie rzeczy denerwuja mnie niemozebnie [i gwoli faktów własnie
jak swego czasu pisałem pare miesiecy w c# ogolnie przychodza
do glowy podobne problemy]











--
Wysłano z serwisu OnetNiusy: http://niusy.onet.pl

do góry