1.0Open Economics Guide of the ZBWhttps://openeconomics.zbw.eu/en/osguidehttps://openeconomics.zbw.eu/en/author/osguide/Making Code Readable and Documenting it – Open Economics Guide of the ZBWrich600338<blockquote class="wp-embedded-content" data-secret="uYbjYp4G3J"><a href="https://openeconomics.zbw.eu/en/knowledgebase/making-code-readable-and-documenting-it/">Making Code Readable and Documenting it</a></blockquote><iframe sandbox="allow-scripts" security="restricted" src="https://openeconomics.zbw.eu/en/knowledgebase/making-code-readable-and-documenting-it/embed/#?secret=uYbjYp4G3J" width="600" height="338" title="“Making Code Readable and Documenting it” — Open Economics Guide of the ZBW" data-secret="uYbjYp4G3J" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" class="wp-embedded-content"></iframe><script type="text/javascript">
/* <![CDATA[ */
/*! This file is auto-generated */
!function(d,l){"use strict";l.querySelector&&d.addEventListener&&"undefined"!=typeof URL&&(d.wp=d.wp||{},d.wp.receiveEmbedMessage||(d.wp.receiveEmbedMessage=function(e){var t=e.data;if((t||t.secret||t.message||t.value)&&!/[^a-zA-Z0-9]/.test(t.secret)){for(var s,r,n,a=l.querySelectorAll('iframe[data-secret="'+t.secret+'"]'),o=l.querySelectorAll('blockquote[data-secret="'+t.secret+'"]'),c=new RegExp("^https?:$","i"),i=0;i<o.length;i++)o[i].style.display="none";for(i=0;i<a.length;i++)s=a[i],e.source===s.contentWindow&&(s.removeAttribute("style"),"height"===t.message?(1e3<(r=parseInt(t.value,10))?r=1e3:~~r<200&&(r=200),s.height=r):"link"===t.message&&(r=new URL(s.getAttribute("src")),n=new URL(t.value),c.test(n.protocol))&&n.host===r.host&&l.activeElement===s&&(d.top.location.href=t.value))}},d.addEventListener("message",d.wp.receiveEmbedMessage,!1),l.addEventListener("DOMContentLoaded",function(){for(var e,t,s=l.querySelectorAll("iframe.wp-embedded-content"),r=0;r<s.length;r++)(t=(e=s[r]).getAttribute("data-secret"))||(t=Math.random().toString(36).substring(2,12),e.src+="#?secret="+t,e.setAttribute("data-secret",t)),e.contentWindow.postMessage({message:"ready",secret:t},"*")},!1)))}(window,document);
//# sourceURL=https://openeconomics.zbw.eu/wp-includes/js/wp-embed.min.js
/* ]]> */
</script>
[vc_row el_class="oeg-kbentry"][vc_column width="2/5" el_class="oeg-kbentry-sidebar-box"][vc_widget_sidebar sidebar_id="knowledgebasesidebaropencodeen" el_class="oeg-kbentry-sidebar"][/vc_column][vc_column width="3/5" el_class="oeg-kbentry-content-box"][vc_column_text el_class="oeg-kbentry-content-title"] [/vc_column_text][vc_column_text css="" el_class="oeg-kbentry-content"]The readability and documentation of code are important to make it understandable for others, but also for yourself. Otherwise, it may even be difficult to understand your own work at a later date, for example after a review by a specialist journal. As with a book, the readability of code is about how you write, organise and comment on it. In addition, there is supplementary documentation about this code. Good readability of code means, for example: Using meaningful and standardised names for variables (also for functions and classes), Structuring […]https://openeconomics.zbw.eu/wp-content/uploads/2008/07/OpenCode-MakingReadable-and-Documenting-it.png20022237