SODA - SharpDevelop Open Development Architecture
Almost all mid to large size software projects have some sort of add-in architecture. An
add-in is basically an extension to the functionality of the main application.
The common way to introduce an add-in structure is to load libraries from a specific
directory at runtime. (Author: Mike Krueger)
Download PDF (318 KB)
SharpDevelop C# Coding Style Guide 0.3
The SharpDevelop C# Coding Style Guide was written by Mike Krueger. This document
can also be read as a guide to writing robust and reliable programs. It focuses on
programs written in C#, but many of the rules and principles are useful even if you
write in another programming language.
Download PDF (265 KB)
Technical Writing Made Easier
Technical writing requires clarity of expression and therefore simplicity of language.
Technical writing is intent on expressing certain key concepts so that these may be understood
as easily as possibly by the intended readers — be they programmers or users. Writing in a
clear, concise manner makes not only understanding the text easier for the reader, it also
makes your life as a writer of technical documentation easier — especially when you are not a
native speaker of English. (Author: Bernhard Spuida)
Download PDF (233 KB)
The fine Art of Commenting
"Commenting is a royal pain in the posterior" - "Comments are for weenies" - "I can understand my
code quite well, thank you very much" - "Good code speaks for itself" - "No time for that, got to
get that code out of the door". None of these is a good reason for not commenting source code properly.
We will look at these arguments, discuss them and take a look at good commenting practice and its benefits.
(Author: Bernhard Spuida)
Download PDF (254 KB)