Kezdőoldal » Számítástechnika » Programozás » Program készítés során mit...

Program készítés során mit jelent az hogy dokumentálni?

Figyelt kérdés

Vizsgára kell készíteni JAVA-ba egy programot. És a feladatban benne van hogy dokumentalja.

Én erre tippelek:

public void Valami() {

/*Ez egy dokumentacio*/

}

Tehát le kell írni a /**/ közé hogy mit csinál az metódus?


2015. jan. 1. 19:01
 1/9 anonim ***** válasza:

Igen azt szokás, de nem csak ilyen formában, hanem manapság vannak erre bevett formázások.

Például java esetében ott a javadoc, pontosan leírja, hogy miként, milyen formában és hova mit kell/szokás írni.

2015. jan. 1. 19:09
Hasznos számodra ez a válasz?
 2/9 A kérdező kommentje:

netBeans-ben dolgozom.

Tehát az akkor egy formázás nem? nem kell új tájlt létrehozni ugye?

2015. jan. 1. 19:24
 3/9 A kérdező kommentje:

[link]


Erről az oldalról ezt szürtem le:

/**

* Ez már egy jó java doc ugye?

*/

2015. jan. 1. 19:26
 4/9 anonim ***** válasza:
Igen, de érdemes ellátni még egyéb hasznos infókkal, például a bemeneti változók típusával, magyarázatával, az eredmény típusával és magyarázatával.
2015. jan. 1. 19:42
Hasznos számodra ez a válasz?
 5/9 anonim ***** válasza:
Leírod szépen a programodba, hogy mi mire való, mire szolgál.
2015. jan. 1. 21:11
Hasznos számodra ez a válasz?
 6/9 anonim ***** válasza:
Lehet, hogy a felhasználói dokumentációra gondoltak.
2015. jan. 2. 13:24
Hasznos számodra ez a válasz?
 7/9 SimkoL ***** válasza:
21%

Dokumentáció: [link]

Amiről ti beszéltek az komment.

2015. jan. 2. 13:29
Hasznos számodra ez a válasz?
 8/9 anonim ***** válasza:
A komment is a dokumentáció része. A suli feladatoknál azért szokták kérni, hogy a tanár könnyebben értékelhesse, és lássa, hogy érted is, amit csinálsz.
2015. jan. 3. 05:15
Hasznos számodra ez a válasz?
 9/9 anonim ***** válasza:

A javadoc vagy a doxygen nem "csak komment".

Rendes dokumentáció, sőt UML modell is készíthető belőle.

2015. jan. 4. 00:06
Hasznos számodra ez a válasz?

Kapcsolódó kérdések:




Minden jog fenntartva © 2024, www.gyakorikerdesek.hu
GYIK | Szabályzat | Jogi nyilatkozat | Adatvédelem | Cookie beállítások | WebMinute Kft. | Facebook | Kapcsolat: info(kukac)gyakorikerdesek.hu

A weboldalon megjelenő anyagok nem minősülnek szerkesztői tartalomnak, előzetes ellenőrzésen nem esnek át, az üzemeltető véleményét nem tükrözik.
Ha kifogással szeretne élni valamely tartalommal kapcsolatban, kérjük jelezze e-mailes elérhetőségünkön!