Klausimai pažymėti „dokumentacija“

TIK TIK DOKUMENTŲ GENERATORIAMS. Įtraukti kalbos ir / arba SDE žymą. NEGALIMA naudoti nuorodų į dokumentus ar įrankius ar kritikuoti tiekėjo dokumentus.
8
atsakymai

Koks skirtumas tarp modulinių, funkcinių, priėmimo ir integracijos testų?

Koks skirtumas tarp vieneto testavimo, funkcinio, priėmimo ir integravimo (ir bet kokių kitų tipų bandymų, kurių nepaminėčiau)?
nustatyti 05 vas '11, 2:59
8
atsakymai

Kas yra standartinis „Python“ dokumentavimo formatas?

Aš mačiau kelis skirtingus rašymo stilius „Python“ dokumentams, ar yra oficialus ar „nuoseklus“ stilius?
nustatyti 10 okt. '10, 4:10
11
atsakymai

Peržiūrėkite „Android“ studijoje pateiktą informaciją apie metodiką

„Eclipse“, kai perkeliate pelės žymeklį ant metodo, pasirodys >
gegužės 18 d., 13 val
4
atsakymai

Ar JavaScript turi komentarų standartą?

Šiuo metu rašau kliento JavaScript kodą ir įdomu, kaip komentuoti savo funkcijas. Aš atėjau iš C # fono, kur yra oficialiai rekomenduojamas „Microsoft“ dokumentuotas komentarų stilius, kurį aš stebiu, o tai leidžia ...
nustatytas balandžio 12 d '12, 18:03
8
atsakymai

Kaip parašyti gerą skaitymą

Manau, visi matė README failą, bet norėčiau, kad galutinis vadovas, kaip parašyti didelį README failą su mažiausia energijos kiekiu. Kas yra readme failas? Ką turėčiau parašyti? Kaip tiksliai ...
nustatyti 21 vas '10, 8:14
20
atsakymai

Geriausi patarimai, kaip dokumentuoti kodą naudojant doksigeną?

Mano komanda pradeda dokumentuoti C kodą naudodama doksigeną, ypatingą dėmesį skirdama mūsų viešoms API antraštėms. Atrodo, kad doksigenas turi daug lankstumo ir įvairių specialių komandų, o tai yra puikus, tačiau neaišku, kas yra geras dalykas ir kas blogas dalykas yra be pro ...
nustatyti 09.09. '08, 14:41 val
49
atsakymai

Kas yra savęs dokumentavimo kodas ir ar jis gali pakeisti gerai dokumentuotą kodą?

Turiu kolegą, kuri tvirtina, kad jo kodui nereikia komentarų, jis „pats dokumentuoja“. Aš pažiūrėjau savo kodą ir, nors ir aiškiau nei kodas, kurį matiau kituose produktuose, vis dar nesutinku su tuo, kad Samodoku ...
spalio 16 d. '08 18:24
6
atsakymai

Kaip parašyti techninės specifikacijos dokumentą mano programinės įrangos projektui?

Čia pastebėjau keletą klausimų, kuriuose teigiama, kad nereikia rašyti perspektyvios techninės specifikacijos, jei funkcinė specifikacija turi visas funkcijas. Kalbant apie situacijas, kai klientas pateikė funkcionalumą ...
Nustatykite kovo 24 d
12
atsakymai

Ar „Swift“ turi dokumentus ar dokumentus?

Daugelis kalbų palaiko dokumentacijos komentarus, leidžiančius generatoriui (pvz., Javadoc arba doksigenui) generuoti kodo dokumentus, analizuojant tą patį kodą. Ar Swift turi pastabų dėl dokumentacijos dokumentacijos ar ...
birželio 5 d. 14 d. 0:34
16
atsakymai

Geras įvadas į .NET Reactive Framework

Ar „Microsoft Reactive“ (Rx) yra geras įvadas ir pamoka, išskyrus „Microsoft“ dokumentus? Be to, kad yra geras pavyzdys (su kodu), „Reactive“ supaprastina programavimo užduotį, kurią sunku išspręsti naudojant įprastinius metodus ...
nustatyti 20 okt. '09 20:33
21
atsakymas

Koks yra geriausias būdas redaguoti „GitHub Readme.md“?

Koks yra geriausias būdas redaguoti „GitHub Readme.md“? Manau, kad redaguojame „Readme“, tada spustelėkite jį, peržiūrėkite klaidas ar formatavimo klaidas, redaguokite jį dar kartą, o tada spustelėkite jį ... Tai tikrai numeris įvykdymo istorijoje. Ar yra spindulys ...
birželio 03 d. 12 val
4
atsakymai

Kokios naujos dokumentacijos komandos yra „Xcode 5“?

Viena iš naujų funkcijų Xcode 5 yra galimybė dokumentuoti savo kodą su specialiu komentarų sintaksu. Formatas yra panašus į doksigeną, tačiau atrodo, kad jis palaiko tik šių funkcijų pogrupį. Kokios komandos yra palaikomos ir kaip ...
nustatyti spalio 03 '13, 23:14
8
atsakymai

Techniniai patarimai, kaip rašyti nuostabų javadoką

Kokie yra jūsų techniniai patarimai, kaip rašyti puikų javadoką? Aš ieškau dalykų, kurie viršija patarimų „Funkcijų paaiškinimas“ standartą. Mes visi tai žinome! (Teisė?) Mane domina tokie dalykai: kurios žymės tikrai turėtų būti ...
gruodžio 29 d '09 23:16
15
atsakymai

Didelės API dokumentacijos kūrimas: įrankiai ir metodai

Man buvo pavesta sukurti interneto paslaugą, kurią naudos keli skirtingi kūrėjai, naudojant skirtingas platformas, dirbdami skirtingoms įmonėms ir turintys gerokai skirtingus įgūdžių lygius. Taigi, norėčiau sukurti dokumentą ...
nustatytas sausio 04 d '10, 23:11
2
atsakymai

Panda programavimo dokumentacija

Taigi, aš visiškai suprantu, kaip naudoti pakartotinį pavyzdį, tačiau dokumentai nepadaro gerų galimybių paaiškinti pasirinktis. Todėl didžioji dalis parinkčių, esančių resample funkcijoje, yra gana paprasti, išskyrus šiuos du variantus: taisyklę: offset string arba o ...
birželio 08 d. 19:09