Kui soovite koodi õppida ja õpetada, võib olla kasulik kood dokumenti kirjutada. See on kasulik ka projekti kavandamise etapis. Võite arvata, et sisestasite lihtsalt kommentaarid koodi, kuid see võib olla tülikas, kuna kommentaarid peavad näitama, kuidas see kood töötab. Dokumendi saate panna projektiideed, kavandamise ja abstraktsed ideed, mis ei kuulu koodikommentaari. Dokument võib sisaldada ka täitmise tulemusi, mis on võimeline järelduste tegemiseks, kuid millel pole lõplikus koodis kohta.

Kood Emacsis

Paljud arendajad kasutavad tarkvara arendamiseks Emacsi, see on võimas koodiredaktor. Tegelikult peavad paljud seda IDE-ks, kui see on õigesti konfigureeritud. Kuid dokumendid on tavaliselt koodist eraldi. Kui soovite koodi demonstreerida või uut projekti kavandada, võite kasutada koodilõike. Selleks, et näidata, kuidas see teie arvates töötab, võite kirjutada sellise dokumendi. Üks võimas viis selleks on luua Org-dokument. Dokumendile koodi lisamiseks peate lisama koodiploki. Koodiplokk on tavaline koodikomplekt, mida näete allpool.

# + begin_src javascript
const rakendus, BrowserWindow = nõuda ('elektron')
const tee = nõuda ('tee')
# + end_src

Tulemus võib minna dokumendile.

See näide ei loo väljundit, lihtsaim viis väljundi saamiseks on shell. Kui soovite käsu käivitada ja tulemusi näidata, peate lisama päise parameetri.

# + begin_src kest: eksportib mõlemad
uname -a
# + end_src
uname -a
Linuxi matid-Ubuntu 5.0.0-20-üldine # 21-Ubuntu SMP esmaspäev, 24. juuni 09:32:09
UTC 2019 x86_64 x86_64 x86_64 GNU / Linux

Tulemuse lisab Emacs plokis käivitava koodi all. Kui soovite täpsemaid tulemusi või soovite plokke ühendada, peate oma lähtekoodi ploki nimetama. Lisage valikuline silt + + NAME:. See silt töötab nii tabelite kui ka koodi jaoks.

Tabel 1.3.1:

x	y	z
0	1	4
1	3	6
2	4	8

Calc-mooduliga saate andmeid sisestada ja tulemusi dokumendis kuvada.

# + begin_src calc: var x = 5: var y = 2: eksportib mõlemad
2 + a * x ** a
# + end_src

Esiteks kuvatakse kood teie määratud vormis. Otse allpool on näidatud tulemused.

2 + a * x ** a
25 a + 2

See on väga lihtne näide, LaTeX-i toega saate tulemuseks kõik soovitud valemid väga hästi vormindatud dokumendis. A

\ begin võrrand
x = \ sqrt b
\ end võrrand

Kui toodate oma koodiga maatükke, saate selle dokumendis kuvada. Allpool näete väga lihtsat koodi, mis kasutab x2 tulemuse joonistamiseks gnuploti.

f (x) = x ** 2
joonis f (x)

Selle toimimiseks peate oma süsteemi installima gnuploti. Kõiki neid funktsioone kutsutakse süsteemist ja esitatakse Emacsis. Sama kehtib kõigi programmeerimiskeelte kohta, mida Emacs toetab.

Kõiki koode ei toetata, karbist väljas

Tõhususe huvides pole kõik toetatud keeled aktiivsed Emacsi vanilliinstallis. Veendumaks, et see on aktiivne, saate lisada koodi oma emacsi konfiguratsioonile init.el on standardfail.

'(org-babel-load-languages
(tsitaat
((python . t)
(emacs-lisp . t)
(kest . t)
(js . t)
(sqlite . t)
(arvutatud . t))))

Ülaltoodud kood võimaldab kuut keelt, seades neile 't'. 't' on Lispis levinud viis tõsi öelda. Selle väärtuse saate määrata ka meetodiga 'M-x customize-variable'. Seda tehes peate sisestama muutuja nime või rühma. Sel juhul on muutuja 'org-babel-load-languages'. Lehele tulles saate vaadata, mida toetatakse, ja aktiveerida soovitud.

Keele lisamine

Kui teie keelt loendis pole, saate keelt otsida aadressilt https: // orgmode.org / worg / org-contrib / babel / keeled.Praegu.html Toetatud keelte loend on juba pikk ja kasvab iga päevaga. Pange tähele, et keele toetamine on vajalik ainult hindamiseks. Ilma selleta toetatakse vaatamist, eksportimist ja sassi ajamist. Nimetatud veebisaidil olete lisanud ka keeled, mille installimiseks on vaja veidi rohkem tööd. Kui te ikka ei näe oma keelt, on selle ise lisamiseks mall. See nõuab mõningaid lisp-programmeerimisoskusi, kuid kui vaadata teisi keeli, peaksite seda suutma lisada ka väheste kogemustega.

Järeldus

See artikkel on kriimustanud ainult seda, mida saate org-režiimiga teha. Saadaval on rohkem funktsioone ja Emacsi lihtsaks redaktoriks nimetamine teeb endale karuteene.