Dokumentation wird im Gegensatz zum sie umgebenden Code nicht ausgeführt und deshalb auch nicht automatisch überprüft. Deshalb ist es fast unmöglich, Dokumentation und Code synchron zu halten, und daher sollte Dokumentation so knapp wie möglich gehalten werden. Kommentarköpfe für Funktionen und Klassen sind eine Ausnahme, weil sie einen wesentlichen Teil der Schnittstellendokumentation darstellen, und die Qualität von Software auch durch die Qualität ihrer Dokumentation bestimmt wird. Code sollte, wo immer möglich, für sich selbst sprechen. Kommentare sollten immer einen Mehrwert haben – und sie sollten niemals dem Code widersprechen, da das im besten Fall zu Vertrauensverlust, im schlechtesten Fall zu grob fehlerhafter Verwendung der Software führt, was ggf. noch nicht einmal auffällt. Dazu kommt: Kommentare und Dokumentationsköpfe sollten auch sprachlich mit dem Einsatzzweck der Software mithalten: knapp, präzise und sprachlich korrekt.

错误:搜索内容不能为空,请输入英文关键词
错误:关键词超出字数限制,请精简
高级检索

Dokumentation im Code

  • Till Biskup

摘要

Dokumentation wird im Gegensatz zum sie umgebenden Code nicht ausgeführt und deshalb auch nicht automatisch überprüft. Deshalb ist es fast unmöglich, Dokumentation und Code synchron zu halten, und daher sollte Dokumentation so knapp wie möglich gehalten werden. Kommentarköpfe für Funktionen und Klassen sind eine Ausnahme, weil sie einen wesentlichen Teil der Schnittstellendokumentation darstellen, und die Qualität von Software auch durch die Qualität ihrer Dokumentation bestimmt wird. Code sollte, wo immer möglich, für sich selbst sprechen. Kommentare sollten immer einen Mehrwert haben – und sie sollten niemals dem Code widersprechen, da das im besten Fall zu Vertrauensverlust, im schlechtesten Fall zu grob fehlerhafter Verwendung der Software führt, was ggf. noch nicht einmal auffällt. Dazu kommt: Kommentare und Dokumentationsköpfe sollten auch sprachlich mit dem Einsatzzweck der Software mithalten: knapp, präzise und sprachlich korrekt.