Academia Stack Exchange is a question and answer site for academics and those enrolled in higher education. It only takes a minute to sign up.
Sign up to join this community
During the compilation of thesis (MSc or PhD) in a case we wanted to include some program codes as chapters:
We prefer to put heading to all program codes everywhere they appear as complete source to clarify the license. Is it nice to do so? Any other solutions?
Something like this:
3.1.1 Loop
...text...
-------
Copyright 2013 Coder, ... !this part
-------
function loop(...) result (...)
some code
-------
...text...
You should add source codes scarcely and when it is interesting to add the code. Loop does not sound one of the interesting headings. In those cases you should include source code as figures and discuss them in your text.
in other cases, you can give complete source codes in appendix or in a CD/DVD as an attachment.
Loop is just for demonstration, you may consider finite difference solver instead :) if you like. Furthermore, We want them to be chapters not an appendix in any form.
Dec 17, 2013 at 8:13
From my own experience and this would depend on your university's guidelines, a summary of the main algorithms of the code ought to be included - specifically with what each algorithm does, what's its significance, how it functions and how it links with the other parts.
In my recently completed and peer reviewed PhD thesis, I also included example 'snippets' or bits of code and included a flowchart of how the program as a whole works, linking all the described algorithms.
I was advised to write chapter subtitles with the context of each algorithm.
function or program printed in your thesis chapters? If so did you include the license part in them?
Dec 17, 2013 at 8:15
functions and their explanation on what they do in a chapter, for example. How about this case?
Dec 17, 2013 at 8:21
Git things however we prefer to include all code in the thesis, so when one has it he/she has everything. We upvoted your answer.
Dec 17, 2013 at 9:10
If you want the code itself out there, put it up on GitHub or BitBucket.
As to the thesis itself, it depends on the pedagogical value --- some algorithms are worth including as code themselves: where the specifics of the language and environment matter. Others are best included as pseudo-code.
licenseas it was not with the code is ignored indeed. We don't want this happen by any extent so.