How to include source code into your dissertation

How to Include Source Code into Your Dissertation

Writing a dissertation often involves conducting research and presenting your findings. If your research involves programming or software development, it is important to include source code in your dissertation to provide a comprehensive understanding of your work. In this article, we will guide you through the process of including source code into your dissertation.

1. Choose the Right Format

Before including source code in your dissertation, you need to decide on the format that best suits your needs. Here are a few common formats:

• Inline Code: This involves inserting small snippets of code within the text of your dissertation. It is ideal for short code snippets or when the code is not the main focus of your research.
• Code Blocks: This format is used when you have longer sections of code that need to be presented as separate blocks. It helps in maintaining readability and clarity.
• Appendix: If your source code is extensive or complex, it may be more appropriate to include it as an appendix at the end of your dissertation. This allows readers to refer to the code while reading your analysis.

2. Format the Source Code

Properly formatting your source code is crucial to ensure readability. Here are a few tips:

• Indentation: Use consistent indentation to make your code more readable. It helps in distinguishing different code blocks and improves the overall presentation.
• Line Numbers: Consider adding line numbers to your code. This makes it easier for readers to refer to specific lines in your analysis or discussions.
• Comments: Include comments in your code to explain complex sections or highlight important details. This helps readers understand your thought process and the purpose of each code segment.

3. Include Source Code in Your Dissertation

Once you have chosen the format and formatted your source code, it's time to include it in your dissertation. Here's how:

Inline Code:

If you are including short snippets of code within the text, you can simply insert them within a sentence or paragraph. Make sure to use a monospaced font to differentiate the code from the regular text. For example:

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer sum = 0; Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium.

Code Blocks:

For longer sections of code, it is best to present them as separate blocks. Use a monospaced font and consider adding line numbers for reference. Here's an example:

function calculateSum(a, b) {
    1 var sum = a + b;
    2 return sum;
}

Appendix:

If your source code is extensive or complex, it is recommended to include it as an appendix. Create a separate section at the end of your dissertation and provide a clear title for the appendix. You can refer to the appendix in your analysis and discussions whenever necessary.

4. Reference the Source Code

When discussing or analyzing your source code, it is important to reference it properly. Here's an example of how to reference inline code:

In line 4 of the code snippet above, the variable sum is assigned the value of a + b.

When referencing code blocks or the appendix, you can mention the page number or section where the code can be found. For example:

Please refer to Appendix A for the complete implementation of the calculateSum function (Page 25).

5. Provide Additional Explanations

While including source code is essential, it is equally important to provide explanations and analysis to help readers understand the significance of the code. Describe the purpose of the code, its functionality, and any important algorithms or techniques used. This will help readers follow your thought process and gain a deeper understanding of your research.

Conclusion

Including source code in your dissertation is crucial when your research involves programming or software development. By choosing the right format, properly formatting the code, and referencing it correctly, you can effectively communicate your work to your readers. Remember to provide additional explanations and analysis to ensure a comprehensive understanding of your research.

References