iwantmyphd
2014-07-08 06:04:09 UTC
Aion sisällyttää laskennallisen mallikoodini (koko) liitteenä väitöskirjaani. Olen käynyt läpi yliopistoni muotoiluohjeet, enkä ole nähnyt mitään oikeaa tapaa muotoilla koodi fontin koon, tekstin rivityksen, välien ja niin edelleen. Mikä on paras tapa tehdä tämä?
Kun luen koodia, vaikka haluaisin sen olevan tyypillinen kirjasinkoko (12 pt), haluaisin myös tekstin rivityksen olevan vähäistä, mutta kun otetaan huomioon perinteiset marginaalivaatimukset, voi olla melko vaikeaa saavuttaa tämä. Koodipolun jättäminen yhdeltä riviltä seuraavalle on yleensä häiritsevää.
Vaikka koodin kommentit estetään suorittamasta käyttämällä merkkijonoa, kuten% tai // tai (* monet kääntäjät värikoodaavat tämän teksti, jotta se on helpommin erotettavissa koodin suoritettavista osista. Onko mitään tapaa tehdä kommentit helposti erottuviksi, kun laitat koodin opinnäytetyön / väitöskirjan tekstiin?
Mitä tekstinkäsittelyohjelmaa käytät?
AilipdtnvoCMT MS Office '08 Mac
Onko neuvonantajalla tai koululla erityisiä ehdotuksia? Jos ei, ydinalgoritmin pseudokoodi on todennäköisesti sopivin yleisölle (tutkielman tutkijat). Sinä. voi aina ladata todellisen koodin githubiin ja mainita sen sekä esimerkkitoteutuksen.
@leonardo Tarkistin yliopiston ohjeet, eikä koodin muotoilussa ollut mitään. Neuvonantajalla / komitean jäsenillä ei ole ehdotuksia tästä.
Sitten valitsen pseudokoodin. Lukijat, joille jokin tietty kieli (tai mikä tahansa kieli) ei ole tuttu, lukevat ja sulavat algoritmin. Keskityisin myös ydinalgoritmiin, koska virheiden käsittelyn kaltaiset asiat ovat hankalia ja häiritseviä.
_ yksipuolinen fontti ... on parasta käyttää luettavuuteen_ - [viittaus vaaditaan]!
Haluatko varmasti _ "... sisällyttää laskennallisen mallikoodini ** kokonaisuutena ** liitteenä" _. Ajattele sitä, että monet eivät ole lukeneet sitä; _a) _ rahasi tuhlaaminen ylimääräisiä sivuja varten ja _b) _ paperin tuhlaaminen. Ehkä voit eristää vain mielenkiintoiset palat?
@JeffE Kiinteämuotoisissa koodeissa yksipuolinen fontti on käytännöllinen välttämättömyys. Myönnän, että kirjoitan joskus Matlab-koodin sans serif -muodossa, mutta se johtuu siitä, että se on vapaamuotoinen. Kaikki sisennyksille herkkä tai suurilla, kovakoodatuilla numeerisilla taulukoilla on paljon helpompaa yksitilassa. Ja kuollut puu -muodossa, kun on vaikea laskea sarakkeiden numeroita, ei-yksipuolinen fontti * voi * aiheuttaa epäselvyyttä sisennysherkässä koodissa. Viite: esivanhempieni käytännön kokemus.
@JeffE Jos napsautat sanaa "yksinäinen", se linkitettiin SE-kysymykseen / vastaukseen, mistä löysin kyseisen tiedon.
Ymmärrän, että koodin kirjoittaminen yksisivuisella kirjasimella on yleinen käytäntö. Kiistän väitteesi, jonka mukaan yleissopimus lisää luettavuutta. @Moriarty: Johdonmukainen, luettavissa oleva sisennys ja taulukon tasaus _ei_ vaadi yksinäistä fonttia.
@JeffE Ymmärrän mielipiteesi ja olen valmis muokkaamaan viestiäni vastaavasti lisäämään sitaatin tai poistamaan yhden paikan kappaleen kokonaan. Pääkysymykseni ei kuitenkaan ollut * fontista sinänsä, vaan * font-size * ja * text-wrapping *. Myös viivan sisennys, kirjasimen väri tai varjostus kommentteja varten ja vastaavat. Ottaen huomioon taustasi ja asiantuntemukseni, olisin hyvin kiinnostunut ajatuksistasi tästä, varsinkin kun en ole lainkaan CS: ssä ja ymmärrykseni koodauskäytännöistä, muotoilusta ja arkistoinnista. Kiitos!
@posdef Neuvojani ja osastojohtajani ovat pyytäneet minua sisällyttämään koodin liitteeseen kokonaisuudessaan (jopa tukitiedostot), vaikka heillä itsellään (eikä yliopistossa tai yliopistossa) ollut ehdotuksia sen oikeasta muotoilusta.
@iwantmyphd näen ... No, toivon, että löydät tyydyttävän vastauksen siinä tapauksessa, valitettavasti minulla ei ole aavistustakaan, onko olemassa tavanomainen tapa sisällyttää niin paljon koodia. :)
Laita se Githubille tai henkilökohtaiselle sivustollesi tai mihin tahansa ja sisällytä linkki siihen opinnäytetyössä.
Voisiko olla parempi isännöidä sitä tietovarastossa, kuten Github, ja antaa linkki siihen opinnäytetyössäsi? Tällä tavalla koodia lukevilla ihmisillä olisi monia arkistojen etuja (esim. Tiedostojen etsiminen, syntaksikorostukset jne.)
Palkkitekstissä viitataan "epäjohdonmukaiseen sisennykseen" ja "kommentointikäytäntöön". Sisäänkäynti- ja kommentointikäytännöt tulisi kattaa tyylin oppaan kielellä, jolla koodisi on, riippumatta siitä, mitä fontin kasvoja tai kokoa käytät.
@ff524 Ja haluamasi tyylioppaat ovat juuri sitä, mitä etsin. Yksi koodi on MatLab, toinen on C, kolmas on Mathematica ja neljäs G-koodi (CNC-koneille).
Niillä ei kuitenkaan ole mitään tekemistä opinnäytetyön kanssa. Katso esim. [C-tyylin oppaat] (http://www.maultech.com/chrislott/resources/cstyle/) (valitse suosikkisi), [MATLAB-tyyliopas] (http://www.cambridge.org/us/academic/subjects / tietojenkäsittelytiede / tieteellinen-laskenta-tieteellinen-ohjelmisto / elementit-matlab-tyyli)