Onko kenelläkään tiedossa nerokasta tapaa projektin dokumentoimiseen? Meinaan sellaista asiaa kun on ohjelman väsännyt ja sitä aikansa muutellut niin hommalla on tietty pyrkimys kohti suurempaa epäjärjestystä. Vaikka rivejä olisikin kommentoitu niin suuret suuntaviivat jäävät piiloon. Eli hakusessa olisi tapa, jolla aliohjelmat, funktiot yms. voisi 'kytkeä' toisiinsa (suurinpiirtein yhdelle A4:lle) ohjelman todellisen toiminnan perusteella.
Onko muuten VB6:ssa ominaisuutta, jolla käyttämättömistä muuttujista/aliohjelmista pääsee eroon?
Doxygen generoi koodeista + niiden kommenteista ihan näppärän dokumentaation kunhan kommentit ovat doxygen-formaatissa ja riittävän monipuoliset.
Kannattaa tutultua UML-kaavioihin. Niillä tehdään monenlaisia kaavioita, joilla voi lukea koodin toiminnan ääriviivoja.
Jaska kirjoitti:
Kannattaa tutultua UML-kaavioihin. Niillä tehdään monenlaisia kaavioita, joilla voi lukea koodin toiminnan ääriviivoja.
Itse en pitänyt yhtään UML:stä kun sitä katselin, liian monta asiaa tehdään samannäköisillä kuvioilla ja muutenkin rasittavaa. Melkeinpä normaalit vuokaaviotkin sopivat paremmin monesti kuin UML, varsinkin aloittelijalle.
Sinänsä mikä tahansa piirto-ohjelma, jossa voi linkata kuvioita toisiinsa ja liikutella niitä kelpaisi tuollaiseen piirtelyyn, mutta hyvää esimerkkiä moisesta ei ole antaa.
feenix kirjoitti:
Itse en pitänyt yhtään UML:stä kun sitä katselin, liian monta asiaa tehdään samannäköisillä kuvioilla ja muutenkin rasittavaa. Melkeinpä normaalit vuokaaviotkin sopivat paremmin monesti kuin UML, varsinkin aloittelijalle.
UML-kaavioihin tutustuminen on kannattavaa mikäli haluaa mallintaa ohjelman toimintaa. Kannattaa valita kaavio aina tilanteen/tarkkuuden mukaan. Komponettikaaviolla voidaan kuvata suurempia kokonaisuuksia kun taas sekvenssi kaaviolla voidaan kuvata mm. aliohjelmien suhteita toisiinsa.
rutkis kirjoitti:
Doxygen generoi koodeista + niiden kommenteista ihan näppärän dokumentaation kunhan kommentit ovat doxygen-formaatissa ja riittävän monipuoliset.
Itsekin käytän doxygeniä (tosin javadocin rinnalla). Kun koodin lisää Javadoc/Doxygeniä varten kommentointia niin siinä samalla koodi tulee varsin hyvin dokumentoiduksi.
Sinis kirjoitti:
Eli hakusessa olisi tapa, jolla aliohjelmat, funktiot yms. voisi 'kytkeä' toisiinsa (suurinpiirtein yhdelle A4:lle) ohjelman todellisen toiminnan perusteella.
Mikäli UML-kaavioita ei halua hyödyntää niin esimerkiksi aliohjelmien kutsujen seuraamiseen voisi soveltua ristiinviiittaustaulu.
esim.
A1 A2 A3 A4
A1 X X
A2
A3 X
A4Esimerkistä nähdään, että aliohjelma A1 kutsuu aliohjelmia A2 ja A3. Aliohjelma A3 Kutsuu aliohjelmaa A4.
Aihe on jo aika vanha, joten et voi enää vastata siihen.