1.0Open Economics Guide der ZBWhttps://openeconomics.zbw.eu/de/osguidehttps://openeconomics.zbw.eu/de/author/osguide/rich600338<blockquote class="wp-embedded-content" data-secret="g4oWt3Rjib"><a href="https://openeconomics.zbw.eu/de/knowledgebase/code-lesbar-machen-und-dokumentieren/">Code lesbar machen und dokumentieren</a></blockquote><iframe sandbox="allow-scripts" security="restricted" src="https://openeconomics.zbw.eu/de/knowledgebase/code-lesbar-machen-und-dokumentieren/embed/#?secret=g4oWt3Rjib" width="600" height="338" title="“Code lesbar machen und dokumentieren” — Open Economics Guide der ZBW" data-secret="g4oWt3Rjib" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" class="wp-embedded-content"></iframe><script> /*! 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="knowledgebasesidebaropencode" 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"]Die Lesbarkeit und Dokumentation von Code sind wichtig, um ihn für andere verständlich zu machen, aber auch für sich selbst. Denn sonst kann es zu einem späteren Zeitpunkt, etwa nach einem Review durch eine Fachzeitschrift, sogar schwierig werden, die eigene Arbeit nachzuvollziehen. Wie bei einem Buch geht es bei der Lesbarkeit von Code darum, wie man diesen schreibt, organisiert und kommentiert. Dazu kommt eine ergänzende Dokumentation über diesen Code.  Eine gute Lesbarkeit von Code selbst bedeutet beispielsweise: Aussagekräftige und einheitliche Namen für Variablen (auch für Funktionen und Klassen) benutzen, […]https://openeconomics.zbw.eu/wp-content/uploads/2008/07/OpenCode-lesbarmachen-dokumentieren.png20022349