Kysymys:
Kuinka muotoilla koodi opinnäytetyössä (Word-asiakirja)?
KonVas
2015-08-18 19:35:35 UTC
view on stackexchange narkive permalink

Minulla on muutama koodinpätkä, jotka sisältyvät tutkielmaani. Mikä on kätevin tapa muotoilla koodi Word-asiakirjaan, erityisesti syntaksikorostuksen ylläpitämiseksi jne.? Ja ohjeissa sanotaan, että tekstissä on käytettävä kaksinkertaista välilyöntiä. Koskeeko tämä myös upotettua koodia?

Mitä tahansa teetkin, älä tee sitä käsin. Käytä automaattista työkalua. Käsin tekeminen tekee sinusta laiskan: kun joudut muuttamaan jotain koodissa, olet liian laiska alustamaan ja testaamaan sitä uudelleen kunnolla, mikä johtaa virheisiin.
Miksi kirjoitat diplomityötä Wordilla? Ehdotan TeX: n käyttöä, mikä tekisi siitä paljon mukavamman sinulle.
Latexin käyttö välttää paljon hankalia elementtejä, kun kootaan suuria komentosarjoja ja asiakirjoja, mutta se vaatii jonkin verran tuntemusta sen paketeista. Se kannattaa oppimiskäyrää, vaikka aion perehtyä seuraavaan.
Kuusi vastused:
Calchas
2015-08-18 21:53:02 UTC
view on stackexchange narkive permalink

Sinun on luotava kappaletyyli asianmukaisilla asetuksilla - yhden aseman fontti yhdelle, todennäköisesti joillekin sisennyksille - ja käytettävä sitä.

Microsoft Wordia käytettäessä sinun on vastustettava kiusausta muuttaa minkä tahansa fontti ollenkaan manuaalisesti. (Ihannetapauksessa poista kirjasinpalkki kokonaan valintanauhasta.) Sen sijaan sinun tulisi luoda kappale- ja merkkityylit ja soveltaa niitä jatkuessasi. Sitten niitä voidaan helposti muokata myöhemmin globaalisti.

Jos tarvitset todella syntaksikorostusta, "paras" tapa olisi todennäköisesti kirjoittaa makro, joka merkitsee koodin eri osat eri merkkityyliin jokaiselle koodielementti ja säädä sitten värit merkkityylieditorissa myöhemmin. Suorita sitten makro jokaisessa koodilohkossa. Epäilen, että tällainen makro on todennäköisesti olemassa jossain.

"Nopea" tapa olisi kopioida ja liittää toisesta ohjelmasta, jossa teksti on jo värillinen.

Haluaisin kopioida / liittää jostakin, joka korostaa syntaksia, siivota sitten ja soveltaa oikeaa kappaletyyliä. Jos katkelmien on oltava tekstin mukaisia ​​pikemminkin kuin (esimerkiksi) liitteessä, harkitse * haluatko * täyden värillisen syntaksikorostuksen vai erotuisiko se liikaa muuhun asiakirjaan verrattuna. Rohkea korostus voi olla puolivälissä talo, jos korostus on tärkeä, samoin kuin harmaasävyt (vaikka ole varovainen luettavuuden suhteen).
mdd
2015-08-18 20:21:36 UTC
view on stackexchange narkive permalink

Yleisin muotoilu, jonka olen nähnyt, on käyttää Courieria (tai Courier Newia) kirjasimena ja lisätä avainsanat (kuten int jne.) lihavoituina . Olen melko varma, että rivivälit eivät koske upotettua koodia (tässä mielessä koodi voi olla samanlainen kuin luku, jossa et yleensä käytä myöskään kaksoisväliä).

Tämä on kuitenkin jotain voit ja sinun pitäisi keskustella hallintosi kanssa, joka saattaisi pystyä antamaan sinulle tarkat asettelu- ja muotoiluvaatimukset. Voit myös vanhemmat opinnäytetyöt näiden vaatimusten lähtötasona.

Joissakin tilanteissa koodi voi hyötyä myös numeroista (esimerkiksi jos haluat viitata tiettyyn riviin koodissa). Se voi kuitenkin olla hankalaa automatisoida MS Wordissa (en halua ehdottaa koodinpätkän liittämistä ja rivinumeroiden lisäämistä manuaalisesti, ja toista sitten tämä toimenpide uudelleen muokkaamisen jälkeen!)
_ laita avainsanat (kuten int jne.) lihavoituna_ - Voi, ei. Nicklaus Wirthin Turing-palkinto olisi peruutettava ** ** siitä, että aloitetaan tämä valtava typografinen käytäntö. Miksi ** maan päällä haluaisit ** korostaa ** syntaktista sokeria?
@JeffE: on samaa mieltä kanssasi. Syntaksi-korostuksen käyttäminen on makukysymys, eikä voi olla hyvä ajatus asettaa sitä lukijalle. OTOH, jos kirjoittaja asettaa koodin saataville myös sähköisesti, niillä, jotka haluavat tutkia sitä tarkemmin, on mahdollisuus avata se haluamallaan editorilla (mahdollisesti syntaksikorostuksella, taittamalla ja monilla muilla mukavilla ominaisuuksilla).
@JeffE: Mitä ehdotat vaihtoehdoksi?
@MatthiasDiener _Älä_ laita avainsanoja lihavoituna.
@JeffE: En usko, ettei "syntaksin korostaminen ollenkaan" ole käyttökelpoinen vaihtoehto.
Matt
2019-08-10 17:20:10 UTC
view on stackexchange narkive permalink

Jos kirjoitat minkä tahansa oikeankokoista asiakirjaa Microsoft Wordissa, tavoitteesi tulisi olla asiakirjan kokoaminen tai koko ennalta määritettyjen muotoilusääntöjen luominen. Tämän mahdollistamiseksi sinun ei pitäisi koskaan koskaan asettaa tekstisi ulkoasua Koti-valintanauhan yksittäisten muotoiluvaihtoehtojen avulla. Pienen muotoilutyylin yksityiskohtien säätäminen myöhemmin tulee todella vaikeaksi ja aikaa vieväksi, jos teet niin.

Microsoft Wordissa on piilotettu kultakaivos - Tyylit-paneeli. Opi se ja huomaat aivan uuden yksinkertaisen tuottavuuden maailman. Wordissa Home-valintanauhan Tyylit-osiossa on pieni "lisää" -painike (korostettu): A screenshot of the Microsoft Word ribbon, with the Styles menu opening button highlighted.

Kun napsautat painiketta, saat Tyylit-paneelin: A screenshot of the Microsoft Word Styles panel.

Tässä kaikki tekstin muotoilutarpeesi pitäisi elää. Tyylejä on kahta päätyyppiä: kappale ja teksti. Suurimman osan tyylistä tulisi olla kappaletyylejä, mikä tarkoittaa, että asetat muotoilun koko kappalelohkolle (näiden vieressä on pieni kappalemerkki), kun taas toinen vain muuttaa tekstin ulkoasua (siellä on vähän " "merkki näiden vieressä".

Nähdäksesi kaikki olemassa olevat tyylit, voit napsauttaa Asetukset-painiketta Tyyli-paneelin alaosassa ja muuttaa asetuksia seuraavasti: A screenshot of the Style panel Options menu.

Tämä näyttää kaikki tyylit. Suosittelen, että jätät yleensä Suositellut-kohtaan tai kun opit, mitkä tyylit pidät eniten, jätät sen Nykyiseen asiakirjaan -luetteloon (se on paljon lyhyempi luettelo ja pidä asiakirjasi puhtaampana).

Koodityylille HTML HTML -muotoiltu kappaletyyli toimii todella hyvin. Ennen: A screenshot of Lorem Ipsum text with an unformatted code block.

vs. jälkeen (Tyylit-paneeli suodatettuna Nykyiseen asiakirjaan): A screenshot of Lorem Ipsum text with a formatted code block.

Jos et pidä jostakin tyylilajin ulkonäöstä, sinun on yksinkertaisesti napsautettava tyyliä hiiren kakkospainikkeella Tyyli-paneelissa ja mukautettava tyyliasetuksia haluamallasi tavalla. Tämä päivittää sitten asiakirjan jokaisen tekstin, jolla on sama muotoilutyyli (tämä on jotain, mitä haluat, katso edellä oleva kirjasinlaji).

Jos et löydä haluamaasi tyyliä, voit myös luoda oman (uusi tyyli-painike Tyyli-paneelin alaosassa). Jos saat haluamasi tyylisarjan, voit viedä ne tai tallentaa ne (Tyylit-paneeli> Tyylien hallinta -painike> Tuo / vie, tallenna sitten uudet tyylit oletusarvoiseen Normal.dotm-tiedostoon tai tallenna tyylitelty asiakirja nimellä uusi dotm, josta voit tuoda tyylejä).

Jos jatkat akateemisen kirjoittamisen tekemistä tai sinulla on lopulta raportteja tai kirjoitettavia asioita, tämän muistaminen tekee sinusta supersankarin Word-tuottavuudesta (ja auttaa sinua saamaan asiakirjat näyttämään uskomattoman puhtailta ja kiillotetuilta).

Aleksandr Blekh
2015-08-18 20:34:21 UTC
view on stackexchange narkive permalink

Pari pistettä. Ensinnäkin ehdotan, että harkitsette huolellisesti, haluatko todella säilyttää syntaksikorostuksen lähdekoodissa, upotettuna opinnäytetyöasiakirjaan. Vaikka käyttää jotakin värimallia on hyväksyttävää ja jopa suositeltavaa (ellei se ole nimenomaisesti kielletty opinnäytetyösi / väitöskirjasi tietyille elementeille tai ollenkaan), liikakäyttö voi kuitenkin olla vahingoittaa valiokuntasi jäsenten vaikutelmaa mahdollisten luettavuus ja saavutettavuus.

ongelmien vuoksi, toiseksi, jos haluat ja pystyt luomaan opinnäytetyön Word-asiakirja LaTeX -palvelusta (en suosittele sitä, koska se voi olla melko hankalaa, ellei sinulla ole siitä kokemusta), lähdekoodin muotoilu muuttuu melko triviaaliksi tehtäväksi vastaavien LaTeX -paketit ja erinomaiset ilmaiset ja avoimen lähdekoodin pandoc -ohjelmistot. Markdown (yhdessä pandoc : n kanssa) voi myös olla toteutettavissa oleva vaihtoehto LaTeX : lle, jos opinnäytetyösi on matemaattista ja muotoilutarpeesi ovat suhteellisen vaatimaton. Edellä mainituista lähestymistavoista on monia yksityiskohtaisia ​​oppaita, mutta vaikka jotkin monimutkaisuudet (ja mahdollisesti jyrkät oppimiskäyrät) jätetään huomioimatta, raportoidut tulokset ovat sekavia.

Kolmanneksi, jotta löydettäisiin optimaalinen Word- ainoa ratkaisu , yritä tarkistaa useita ensimmäisiä sivuja yli 3 miljoonasta Google-haun tuloksesta lähdekoodin kohokohta sana asiakirja Olen melko varma, että siellä on joitain kunnollisia menetelmiä. Jos haluat yksinkertaistetun lähestymistavan, harkitse yksipuolisen fontin käyttöä. Joitakin muita yksinkertaisia ​​ratkaisuja löytyy vastauksista tähän suosittuun kysymykseen aiheesta StackOverflow .

Henkilökohtaisesti haluaisin syntaksin korostamisen kaikissa tilanteissa, joissa luen koodia.
@FedericoPoloni: Ymmärrän varmasti sinut. Kaikki riippuu kuitenkin _henkilökohtaisista mieltymyksistä_ ja / tai _konteksteista (ts. Kontekstissa on merkittävä ero siinä, että luet joitakin koodinpätkiä näytössä olevassa opetusohjelmassa ja tarkastellaan koodia, joka on upotettu enimmäkseen mustavalkoiseen akateemiseen asiakirjaan, kuten opinnäytetyö).
Jimi Sanchez
2015-08-20 04:09:00 UTC
view on stackexchange narkive permalink

Luulen, että tämä riippuu tarkoituksesta. Kysy opinnäytetyön ohjaajalta / osastojen puheenjohtajilta. Minun piti sisällyttää opinnäytteelleni joitain koodikatkelmia. Puheenjohtajani käskivät minua lähettämään koodin Githubiin ja hankkimaan siihen liittyvän DOI-numeron.

Katsokaa näitä kahta linkkiä: https://guides.github.com/activities/citable-code/ ja http://figshare.org/ koska ne voivat auttaa sinua prosessissasi.

Jos sinun on sisällytettävä koodi opinnäytetyön tekstiosaan sen sijaan, että se olisi viite tai linkki liitteeseen, katsokaa tätä pinovertausta vastauksen, koska näyttää siltä, ​​että se palvelisi täydellisesti: https://stackoverflow.com/a/2653406/4885396

KonVas
2015-08-21 20:22:46 UTC
view on stackexchange narkive permalink

Paras löytämäni ratkaisu (joka toimii minulle hyvin) on koodaus kielillä IDE, joka käyttää korostusta kielten tyylin mukaan. Kopioin ja liitän sitten upotetun objektin (Word-asiakirja) Word-editoriin. Kiva asia siinä on, että Word kohtelee sitä kuvana, jotta voin sijoittaa kuvatekstin, eikä Word yritä tarkistaa oikeinkirjoitusta. Tämä on linkki, josta sain ratkaisun, joka toimi minulle.



Tämä Q & A käännettiin automaattisesti englanniksi.Alkuperäinen sisältö on saatavilla stackexchange-palvelussa, jota kiitämme cc by-sa 3.0-lisenssistä, jolla sitä jaetaan.
Loading...