Warsztat - Programowanie gier

Wrzesień 03, 2010, 03:57:14 *
Witamy, Gość. Zaloguj się, lub zarejestruj proszę.

Zaloguj się podając nazwę użytkownika, hasło i długość sesji
Aktualności: Warsztat, Regulamin forum, #warsztat, Wiki, FAQ, NoPaste, Mapa
 
   Strona główna   Pomoc Szukaj Zaloguj się Rejestracja  
Strony: 1 2 [3]
  Drukuj  
Autor Wątek: Zaawansowani a komentarze w kodzie  (Przeczytany 5026 razy)
RageX
Gość
« Odpowiedz #30 : Czerwiec 19, 2007, 11:25:48 »

Tak, wiem co to. I popieram...
komentarze = "nie musisz, nie pisz", jak wiesz że musisz, to pisz.
Zapisane
Charibo
Member2000
*******

wiadomości: 2401



Zobacz profil WWW
« Odpowiedz #31 : Czerwiec 19, 2007, 11:29:54 »

Komentarze maja niewiele wspolnego z dokumentacja. Komentarz objasnia konstrukcje kodu, co bardziej skomplikowane fragmenty implementacji itp., a dokumentacja opisuje jedynie interface biblioteki, aby jej uzytkownik mogl wygodnie ja obslugiwac
Zapisane

Now these points of data make a beautiful line
And we're out of beta we're releasing on time.

Blogassek.
Riddlemaster
SuperHero Member
******

wiadomości: 1626


Dive now, work later


Zobacz profil WWW
« Odpowiedz #32 : Czerwiec 19, 2007, 11:35:32 »

Dokumentacja techniczna IMO = wszystko co pozwala w zrozumieniu budowanego systemu, projektu informatycznego itp., zarówno od strony niskopoziomowej (kod) jak i bardziej abstrakcyjnej (relacje pomiędzy poszczególnymi podsystemami) czyli:
- specyfikacja wymagań, user stories, karty CRC
- diagramy w wybranym języku opisu modelu (np. UML 2.x, ale też i własne języki firm - z takimi też można się spotkać)
- komentarze w kodzie
- opis poszczególnych modułów, interfejsów, algorytmów
Zapisane

RageX
Gość
« Odpowiedz #33 : Czerwiec 19, 2007, 11:41:06 »

A kto jest użytkownikiem twojego kodu? ALbo ty po długim okresie czasu albo inny programista. Jeśli kod jest otwarty, nie zamknięty w biblioteke, to komentarze są częścią dokumetacji. Jeśli ty odejdziesz z roboty, a twój kod zostanie... to musi być czytelna i treść, i forma.
Dlatego też napisałem rozszerzyć pojęcie komentarze o bardziej ogólne pojęcie dokumentacji.

Oraz, tutaj to lepiej ode mnie napisali:

http://www.linfo.org/documentation.html
"Good documentation also facilitates the improving, extending and updating of software. Because programs can be extremely complex, their developers often forget what they were doing or thinking when they created them, particularly after the passage of long periods of time. Moreover, it is frequently the case that some or all of the original writers of a program are no longer available, thus making it even more difficult to understand the original software in order to improve, extend or update it. It is often said that the largest cost of software is not creating it, but rather maintaining it (i.e., correcting errors and updating it); good documentation can help reduce this cost. Good documentation can also help users make useful suggestions for improving the software."

Edit: Oraz ten fragment -
"One of the most important forms of documentation for computer software is one that ordinary users rarely, if ever, see. It is the comments that are included in the source code of programs. Source code is the version of software (usually an application program or an operating system) as it is originally written (i.e., typed into a computer) by a human in plain text (i.e., human readable alphanumeric characters) in a programming language."
« Ostatnia zmiana: Czerwiec 19, 2007, 11:44:58 wysłane przez RageX » Zapisane
Charibo
Member2000
*******

wiadomości: 2401



Zobacz profil WWW
« Odpowiedz #34 : Czerwiec 19, 2007, 11:52:28 »

No tak - dlatego warto wlasnie rozroznic komentarze w kodzie (przeznaczone dla developerow biblioteki) od dokumentacji biblioteki (przeznaczonej dla uzytkownikow, end-userow czy jak ich tam nazwiesz)
Zapisane

Now these points of data make a beautiful line
And we're out of beta we're releasing on time.

Blogassek.
Krukers
Newbie
*

wiadomości: 14



Zobacz profil
« Odpowiedz #35 : Czerwiec 19, 2007, 20:34:03 »

Bylem dzisiaj na rozmowie kwalifikacyjnej w dosc duzej firmie softw.
Co mnie zadziwilo: praktycznie nie bylo pytania zwiazanego ze znajomoscia jezyka, bibliotek - zadnego testu, problemu do rozwiazania.

Za to pierwsze pytanie bylo the best: czy komentuje Pan swoje kody Grin
Byly tez pytania co do dokumentowania napisanego kodu, stycznosci z systemami kontroli wersji.

Zeby nie bylo offtopa - ja preferuje sposob Rega Smiley
Zapisane

Strony: 1 2 [3]
  Drukuj  
 
Skocz do:  

Hosting: Polska Strefa - Ogłoszenia
Powered by SMF 1.1.7 | SMF © 2006, Simple Machines LLC