Formatting code in research reports

Posted by RoseOfJericho on Stack Overflow See other posts from Stack Overflow or by RoseOfJericho
Published on 2010-03-18T06:00:26Z Indexed on 2010/03/21 16:41 UTC
Read the original article Hit count: 342

Filed under:

reports

|

source-code

|

writing

I am currently writing a formal research report, and I'll be including JavaScript and PHP code. None of the sections of code will be more than 25 lines (so they're mere snippets). There will be approx. half a dozen snippets, each of which will have a couple of paragraphs explaining what is happening in the code and a discussion on its pros/cons.

Is there an accepted way of displaying code in research reports? I'm thinking in terms of font, spacing, whether the code should be displayed inside the document or in an appendix, and related details.

I have no contact with the body the report will be submitted to, and they have no published guidelines on how to format code.

© Stack Overflow or respective owner

Related posts about reports

Grep Crystal Reports (with Sub-reports)

as seen on Stack Overflow - Search for 'Stack Overflow'
I need a way to quickly search a large number of Crystal reports (with sub-reports) for the names of several stored procedures. (Trying to find dependencies.) I'm running Windows XP and downloaded this grep program - http://www.wingrep.com/download.htm. So far, I'm not convinced that it's working… >>> More
Scheduling parameterized reports in Crystal Reports Server

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm trying to set up a report to run monthly in Crystal Reports Server 2008 that will give me the next month's Affordable Care Plan termination dates. However, as far as I can tell, I can only give it a particular date string, not "7 days after the report is scheduled". How do I do this? (Same question… >>> More
SQL Server Reports IDE for creating reports

as seen on Stack Overflow - Search for 'Stack Overflow'
I have to modify SQL Server reports. It is not easy to modify directly XML report file (*.rdl). Is there any IDE for editing SQL Server Reports? >>> More
Alternate line colors in reports using Crystal Reports

as seen on C# Corner - Search for 'C# Corner'
Sometimes when we have a big reports displaying heavy textual information, one technique to visualize data in a consistent way is to shade line in alternate colors. In this article, I will show how Crystal Reports enables this technique very easily. >>> More
How to convert SSRS 2008 Server reports to SSRS 2008 Client Reports

as seen on Stack Overflow - Search for 'Stack Overflow'
I have a large SSRS 2008 Server Report Project (more than 200 reports). Currently my companystrategy has been changed and we want to convert these server reports to client reports. All of the Server reports uses Storeprocedures (or in some cases from the SQl Functions) All of them work properly… >>> More

Related posts about source-code

svn: Syncing main source code with committed source code

as seen on Server Fault - Search for 'Server Fault'
To manage my source code I have created SVN subversion server by using command svnadmin create /myrepos svn import /root/MySourceCode file:///myrepos I have created user and provided rw access to him. User can easily commit their changes in repository. How can I update my sourcecode (/root/MySourceCode)… >>> More
Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
Freelancing - Share the source code?

as seen on Programmers - Search for 'Programmers'
I have developed a couple of form based windows application in vb.net for a client and they all work well and he paid me through a freelance site. I have handed over the executable and the setup to the client and all was well. Now the client wants the source code for the application. Is there a general… >>> More
Software for "High-level" source code (C++) Management

as seen on Programmers - Search for 'Programmers'
after a lot of small-medium projects, I have a lot of libraries and test programs here and there. Also, I must admit that some of the "best practices" I learnt are not that "good" IMHO. In particular, documenting your code and making a "high-level" documentation is not useful in practice: High-level… >>> More
Static source code analysis for C# that operates on source code level

as seen on Stack Overflow - Search for 'Stack Overflow'
Current static source analysis tools for C# (or other .NET languages) usually operate on the assembly-level. They use reflection to analyse the code. Are there tools available that operate on a source code level only (like lint for C)? >>> More