{"id":506,"date":"2021-12-28T18:56:29","date_gmt":"2021-12-28T17:56:29","guid":{"rendered":"https:\/\/www.kehrwasser.com\/blog\/?p=506"},"modified":"2021-12-28T18:56:29","modified_gmt":"2021-12-28T17:56:29","slug":"dokumentation-im-code-ja-oder-nein","status":"publish","type":"post","link":"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/","title":{"rendered":"Dokumentation im Code  &#8211; ja oder nein?"},"content":{"rendered":"<p>Programmcode wird zwar immer f\u00fcr Maschinen geschrieben, aber wirklich gut ist er erst, wenn ihn auch Menschen ohne Schwierigkeiten lesen k\u00f6nnen. Doch was hei\u00dft \u201eohne Schwierigkeiten\u201c? Viele Entwickler setzen dazu auf eine mehr oder weniger detaillierte Dokumentation des Codes. Der Gedanke ist klar: Kommentare sollen helfen, den Code besser nachzuvollziehen und Nachfragen oder gar Missverst\u00e4ndnisse zu vermeiden. Aber sollte ein guter Code nicht eigentlich selbsterkl\u00e4rend sein? Wir gehen der Frage nach.<\/p>\n<h4 class=\"wp-block-heading\">Warum Code \u00fcberhaupt dokumentiert wird<\/h4>\n<p>Kommentare zwischen den Codezeilen sind nicht per se schlecht. Sie haben ihre Daseinsberechtigung. Ein Beispiel: Sie m\u00f6chten komplexe Funktionsabschnitte deklarieren. Oder Sie m\u00f6chten erw\u00e4hnen, warum Sie an einer bestimmten Stelle genau diese Parameter verwenden und keine anderen. Problematisch wird es dann, wenn Sie<\/p>\n<ul class=\"wp-block-list\"><li>mehr Augenmerk auf die Dokumentation legen als auf den Code selber, und<\/li>\n<li>die Funktionalit\u00e4t des Codes statt seiner Intention kommentieren.<\/li><\/ul>\n<p>Hinter einer \u00fcbereifrigen Dokumentation steckt oft die Angst, dass andere den Code falsch oder gar nicht verstehen k\u00f6nnten. Denken Sie umgekehrt: Wie l\u00e4sst sich Code schreiben, damit er keiner weiteren Kommunikation bedarf? Denn dann kommen Sie schnell an den Punkt, an dem Ihnen klar wird, dass 99% aller Kommentare \u00fcberfl\u00fcssig sind.<\/p>\n<h4 class=\"wp-block-heading\">Ein guter Code spricht f\u00fcr sich<\/h4>\n<p>Je weniger Sie kommentieren, desto st\u00e4rker m\u00fcssen Sie auf klare und strukturierte Anweisungen achten. Clean Code zwingt Sie gewisserma\u00dfen ganz von selbst dazu, m\u00f6glichst simpel und effizient zu coden, weshalb dieses Prinzip in der Softwareentwicklung auch so hochgelobt ist. Versuchen Sie mit Ihren Codezeilen zu kommunizieren, statt sich in ausufernden Dokumentationen zu verlieren. Hier sind vier Gr\u00fcnde, warum Sie zuk\u00fcnftig weniger kommentieren sollten:<\/p>\n<p>1.\u00a0\u00a0\u00a0\u00a0\u00a0 Kommentare lenken ab<\/p>\n<p>Ein perfekter Code hat immer einen gewissen Fluss, wenn Sie ihn durchgehen, so als w\u00fcrden Sie einen fl\u00fcssigen Text lesen. Kommentare unterbrechen diesen Fluss ausnahmslos und erschweren so in vielen F\u00e4llen \u2013 paradoxerweise \u2013 das Verst\u00e4ndnis des Codes. Das ist vor allem dann der Fall, wenn es sich um redundante Kommentare handelt, die keine neuen Informationen liefern.<\/p>\n<p>2.\u00a0\u00a0\u00a0\u00a0\u00a0 Kommentare kosten Zeit<\/p>\n<p>Zeit ist die kostbarste Ressource in der Softwareentwicklung. \u00dcberschlagen Sie einmal in Gedanken, wie viel Zeit Ihnen das Verfassen der Kommentare kostet und wie viel Zeit andere damit verbringen, diese zu lesen und mit dem Code in Einklang zu bringen. Und wer pflegt und aktualisiert die Kommentare, wenn der Code zu einem sp\u00e4teren Zeitpunkt angepasst werden muss? Der Punkt ist: Dokumentieren geht immer zu Lasten der Produktivit\u00e4t. Wenn Sie dauerhaft schneller und effizienter arbeiten wollen, m\u00fcssen Sie rigoros Kommentare einsparen.<\/p>\n<p>3.\u00a0\u00a0\u00a0\u00a0\u00a0 Schlechte Kommentare verwirren Ihre Kollegen<\/p>\n<p>Vielleicht kennen Sie das Szenario selbst: Jemand kommentiert etwas v\u00f6llig Offensichtliches und Sie fragen sich insgeheim: Warum wird das kommentiert? Steckt noch mehr dahinter? L\u00e4sst sich das auch anders interpretieren? Redundante oder irref\u00fchrende Kommentare k\u00f6nnen eine ganze Menge Probleme verursachen, die v\u00f6llig unn\u00f6tig sind. Vertrauen Sie Ihren Programmierfertigkeiten und denen Ihrer Kollegen. So oder so werden Kommentare Ihren Code nicht besser machen.<\/p>\n<p>4.\u00a0\u00a0\u00a0\u00a0\u00a0 Kommentare \u00fcberlagern die Neutralit\u00e4t des Codes<\/p>\n<p>Programmiersprachen sind neutral, eigene Kommentare nicht. Denken Sie immer daran, dass Ihre Kommentare Teil des Quellcodes sind und von jedem, der damit arbeitet, eingesehen werden k\u00f6nnen. Besonders relevant ist dieser Punkt f\u00fcr jeden, der dazu neigt, Kommentare auch als eine Art Notizen zu verwenden. Gestern Nacht noch kurz etwas vermerkt, am n\u00e4chsten Morgen l\u00e4ngst vergessen \u2013 und Ihr Kollege am\u00fcsiert sich pr\u00e4chtig. Darum sollten Sie sich angew\u00f6hnen, so wenige Kommentare wie nur m\u00f6glich zu hinterlassen.<\/p>\n<h4 class=\"wp-block-heading\">Fazit: Gute Programmierer kommunizieren mit ihrem Code<\/h4>\n<p>Schreiben Sie Programmiercode so, dass man ihn auch ohne oder nur mit wenigen Kommentaren verstehen kann. Damit sparen Sie selbst und anderen eine Menge Zeit, arbeiten produktiver und fokussieren sich auf klare, einfache Strukturen. Erfahrungsgem\u00e4\u00df l\u00e4sst dies auch das Vertrauen in die eigenen F\u00e4higkeiten wachsen, weil Sie lernen, ausschlie\u00dflich mit Ihrem Code zu kommunizieren.<\/p>","protected":false},"excerpt":{"rendered":"<p>Programmcode wird zwar immer f\u00fcr Maschinen geschrieben, aber wirklich gut ist er erst, wenn ihn auch Menschen ohne Schwierigkeiten lesen k\u00f6nnen. Doch was hei\u00dft \u201eohne Schwierigkeiten\u201c? Viele Entwickler setzen dazu auf eine mehr oder weniger detaillierte Dokumentation des Codes. Der Gedanke ist klar: Kommentare sollen helfen, den Code besser nachzuvollziehen und Nachfragen oder gar Missverst\u00e4ndnisse [&hellip;]<\/p>","protected":false},"author":7,"featured_media":507,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[42],"tags":[132,133,134,101],"class_list":["post-506","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-technologien","tag-coding","tag-dokumentation","tag-programmcode","tag-programmierung"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.4 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Dokumentation im Code - ja oder nein? - Looped Learning<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/\" \/>\n<meta property=\"og:locale\" content=\"de_DE\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Dokumentation im Code - ja oder nein? - Looped Learning\" \/>\n<meta property=\"og:description\" content=\"Programmcode wird zwar immer f\u00fcr Maschinen geschrieben, aber wirklich gut ist er erst, wenn ihn auch Menschen ohne Schwierigkeiten lesen k\u00f6nnen. Doch was hei\u00dft \u201eohne Schwierigkeiten\u201c? Viele Entwickler setzen dazu auf eine mehr oder weniger detaillierte Dokumentation des Codes. Der Gedanke ist klar: Kommentare sollen helfen, den Code besser nachzuvollziehen und Nachfragen oder gar Missverst\u00e4ndnisse [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/\" \/>\n<meta property=\"og:site_name\" content=\"Looped Learning\" \/>\n<meta property=\"article:published_time\" content=\"2021-12-28T17:56:29+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.kehrwasser.com\/blog\/wp-content\/uploads\/2021\/12\/pexels-pixabay-270557.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"2316\" \/>\n\t<meta property=\"og:image:height\" content=\"1542\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Florian Kastner\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Verfasst von\" \/>\n\t<meta name=\"twitter:data1\" content=\"Florian Kastner\" \/>\n\t<meta name=\"twitter:label2\" content=\"Gesch\u00e4tzte Lesezeit\" \/>\n\t<meta name=\"twitter:data2\" content=\"3\u00a0Minuten\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/\",\"url\":\"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/\",\"name\":\"Dokumentation im Code - ja oder nein? - Looped Learning\",\"isPartOf\":{\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/i0.wp.com\/www.kehrwasser.com\/blog\/wp-content\/uploads\/2021\/12\/pexels-pixabay-270557.jpg?fit=2316%2C1542&ssl=1\",\"datePublished\":\"2021-12-28T17:56:29+00:00\",\"author\":{\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/#\/schema\/person\/8eb5df6fda44e11f99b648c67503ad7a\"},\"breadcrumb\":{\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/#breadcrumb\"},\"inLanguage\":\"de\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"de\",\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/#primaryimage\",\"url\":\"https:\/\/i0.wp.com\/www.kehrwasser.com\/blog\/wp-content\/uploads\/2021\/12\/pexels-pixabay-270557.jpg?fit=2316%2C1542&ssl=1\",\"contentUrl\":\"https:\/\/i0.wp.com\/www.kehrwasser.com\/blog\/wp-content\/uploads\/2021\/12\/pexels-pixabay-270557.jpg?fit=2316%2C1542&ssl=1\",\"width\":2316,\"height\":1542},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Startseite\",\"item\":\"https:\/\/www.kehrwasser.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Dokumentation im Code &#8211; ja oder nein?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/#website\",\"url\":\"https:\/\/www.kehrwasser.com\/blog\/\",\"name\":\"Looped Learning\",\"description\":\"#innovation, #ki, #newWork, #agile, #validatedLearning\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.kehrwasser.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"de\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/#\/schema\/person\/8eb5df6fda44e11f99b648c67503ad7a\",\"name\":\"Florian Kastner\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"de\",\"@id\":\"https:\/\/www.kehrwasser.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/51c32ef128ab9aa347d039481bd03fc247cdfbc3070ac84ffa7aabf609fb76c7?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/51c32ef128ab9aa347d039481bd03fc247cdfbc3070ac84ffa7aabf609fb76c7?s=96&d=mm&r=g\",\"caption\":\"Florian Kastner\"},\"url\":\"https:\/\/www.kehrwasser.com\/blog\/author\/kw-florian-kastner\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Dokumentation im Code - ja oder nein? - Looped Learning","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/","og_locale":"de_DE","og_type":"article","og_title":"Dokumentation im Code - ja oder nein? - Looped Learning","og_description":"Programmcode wird zwar immer f\u00fcr Maschinen geschrieben, aber wirklich gut ist er erst, wenn ihn auch Menschen ohne Schwierigkeiten lesen k\u00f6nnen. Doch was hei\u00dft \u201eohne Schwierigkeiten\u201c? Viele Entwickler setzen dazu auf eine mehr oder weniger detaillierte Dokumentation des Codes. Der Gedanke ist klar: Kommentare sollen helfen, den Code besser nachzuvollziehen und Nachfragen oder gar Missverst\u00e4ndnisse [&hellip;]","og_url":"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/","og_site_name":"Looped Learning","article_published_time":"2021-12-28T17:56:29+00:00","og_image":[{"width":2316,"height":1542,"url":"https:\/\/www.kehrwasser.com\/blog\/wp-content\/uploads\/2021\/12\/pexels-pixabay-270557.jpg","type":"image\/jpeg"}],"author":"Florian Kastner","twitter_card":"summary_large_image","twitter_misc":{"Verfasst von":"Florian Kastner","Gesch\u00e4tzte Lesezeit":"3\u00a0Minuten"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/","url":"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/","name":"Dokumentation im Code - ja oder nein? - Looped Learning","isPartOf":{"@id":"https:\/\/www.kehrwasser.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/#primaryimage"},"image":{"@id":"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/#primaryimage"},"thumbnailUrl":"https:\/\/i0.wp.com\/www.kehrwasser.com\/blog\/wp-content\/uploads\/2021\/12\/pexels-pixabay-270557.jpg?fit=2316%2C1542&ssl=1","datePublished":"2021-12-28T17:56:29+00:00","author":{"@id":"https:\/\/www.kehrwasser.com\/blog\/#\/schema\/person\/8eb5df6fda44e11f99b648c67503ad7a"},"breadcrumb":{"@id":"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/#breadcrumb"},"inLanguage":"de","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/"]}]},{"@type":"ImageObject","inLanguage":"de","@id":"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/#primaryimage","url":"https:\/\/i0.wp.com\/www.kehrwasser.com\/blog\/wp-content\/uploads\/2021\/12\/pexels-pixabay-270557.jpg?fit=2316%2C1542&ssl=1","contentUrl":"https:\/\/i0.wp.com\/www.kehrwasser.com\/blog\/wp-content\/uploads\/2021\/12\/pexels-pixabay-270557.jpg?fit=2316%2C1542&ssl=1","width":2316,"height":1542},{"@type":"BreadcrumbList","@id":"https:\/\/www.kehrwasser.com\/blog\/2021\/12\/28\/dokumentation-im-code-ja-oder-nein\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Startseite","item":"https:\/\/www.kehrwasser.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Dokumentation im Code &#8211; ja oder nein?"}]},{"@type":"WebSite","@id":"https:\/\/www.kehrwasser.com\/blog\/#website","url":"https:\/\/www.kehrwasser.com\/blog\/","name":"Looped Learning","description":"#innovation, #ki, #newWork, #agile, #validatedLearning","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.kehrwasser.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"de"},{"@type":"Person","@id":"https:\/\/www.kehrwasser.com\/blog\/#\/schema\/person\/8eb5df6fda44e11f99b648c67503ad7a","name":"Florian Kastner","image":{"@type":"ImageObject","inLanguage":"de","@id":"https:\/\/www.kehrwasser.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/51c32ef128ab9aa347d039481bd03fc247cdfbc3070ac84ffa7aabf609fb76c7?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/51c32ef128ab9aa347d039481bd03fc247cdfbc3070ac84ffa7aabf609fb76c7?s=96&d=mm&r=g","caption":"Florian Kastner"},"url":"https:\/\/www.kehrwasser.com\/blog\/author\/kw-florian-kastner\/"}]}},"jetpack_featured_media_url":"https:\/\/i0.wp.com\/www.kehrwasser.com\/blog\/wp-content\/uploads\/2021\/12\/pexels-pixabay-270557.jpg?fit=2316%2C1542&ssl=1","jetpack-related-posts":[],"jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/posts\/506","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/comments?post=506"}],"version-history":[{"count":1,"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/posts\/506\/revisions"}],"predecessor-version":[{"id":508,"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/posts\/506\/revisions\/508"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/media\/507"}],"wp:attachment":[{"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/media?parent=506"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/categories?post=506"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.kehrwasser.com\/blog\/wp-json\/wp\/v2\/tags?post=506"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}