| |
| Autor |
 IDE-Frage |
|
Bekell
Aktiv 
Dabei seit: 05.09.2008
Mitteilungen: 3056
 |  Themenstart: 2022-11-22
|
Hallo, kennt jemand ein IDE für Python, wo man mehr Kommentar eingeben kann, und dieser nur auf den Drucke eines Zeichen hin angezeigt wird.
Bei mir wird der Code zu schnell unübersichtlich, wenn ich soviel Kommentar eingebe, dass ich auch noch nach ein paar Monaten noch verstehe. Abhilfe gäbe ein eigenes Kommentarfenster zu den Zeilennummern des Codes. Vllt gibt es sowas ja schon?
|
 Profil
|
DerEinfaeltige
Senior 
Dabei seit: 11.02.2015
Mitteilungen: 3227
 | Beitrag No.1, eingetragen 2022-11-23
|
Man kann beliebig viel Kommentar eingeben und statt mit Zeilennummern zu arbeiten, sollte man seine Module, Methoden und Klassen besser dokumentieren.
Beispiel:
\sourceon Python
\numberson
def ggT(a:int,b:int) -> int:
"""
Berechnet den größten gemeinsamen Teiler zweier ganzer Zahlen a und b.
Parameter:
----------
a: int
Erste Zahl
b: int
Zweite Zahl
Rückgabewert:
-------------
int:
Der ggT der beiden Zahlen
Beispiele:
----------
ggT(10,6) := 2
ggT(156,3072) := 12
"""
if b == 0:
return a
return ggT(b, a%b)
\sourceoff
ergibt dann in Zukunft bei Mausover auf ggT in einer normalen IDE das Popup:
(function) ggT: (a: int, b: int) -> int
Berechnet den größten gemeinsamen Teiler zweier ganzer Zahlen a und b.
Parameter:
a: int
Erste Zahl
b: int
Zweite Zahl
Rückgabewert:
int:
Der ggT der beiden Zahlen
Beispiele:
ggT(10,6) := 2
ggT(156,3072) := 12
|
Profil
|
Bekell
Aktiv
Dabei seit: 05.09.2008
Mitteilungen: 3056
| Beitrag No.2, vom Themenstarter, eingetragen 2022-11-23
|
Oh, das ist wirklich sehr nützlich, probier es gleich mal aus ....
|
Profil
|
Delastelle
Senior
Dabei seit: 17.11.2006
Mitteilungen: 2208
 | Beitrag No.3, eingetragen 2022-11-23
|
Hallo,
eine Empfehlung zum Programmieren lautet:
Kommentare und Programmcode sollen etwa wie 1:1 verteilt sein.
D.h. auf 20 Zeilen Code sollen 20 Zeilen Kommentare entfallen.
Viele Grüße
Ronald
(der sich selbst meist an diese Empfehlung nicht ganz hält und weniger Kommentare verwendet...)
|
Profil
|
Scynja
Senior
Dabei seit: 23.02.2011
Mitteilungen: 562
Wohnort: Deutschland
| Beitrag No.4, eingetragen 2022-11-28
|
\quoteon(2022-11-23 12:46 - Delastelle in Beitrag No. 3)
Hallo,
eine Empfehlung zum Programmieren lautet:
Kommentare und Programmcode sollen etwa wie 1:1 verteilt sein.
D.h. auf 20 Zeilen Code sollen 20 Zeilen Kommentare entfallen.
Viele Grüße
Ronald
(der sich selbst meist an diese Empfehlung nicht ganz hält und weniger Kommentare verwendet...)
\quoteoff
Hallo Deltastelle, woher hast du diese Empfehlung? Insbesondere bei trivialen Funktionen und bei Boilerplate-code sind Kommentare doch eher Ballast, als das sie helfen.
Wenn man eine Bibliothek entwickelt, sieht das natürlich anders aus.
|
Profil
|
Delastelle
Senior
Dabei seit: 17.11.2006
Mitteilungen: 2208
| Beitrag No.5, eingetragen 2022-11-30
|
Hallo,
\quoteon(2022-11-28 19:51 - Scynja in Beitrag No. 4)
\quoteon(2022-11-23 12:46 - Delastelle in Beitrag No. 3)
Hallo,
eine Empfehlung zum Programmieren lautet:
Kommentare und Programmcode sollen etwa wie 1:1 verteilt sein.
D.h. auf 20 Zeilen Code sollen 20 Zeilen Kommentare entfallen.
Viele Grüße
Ronald
(der sich selbst meist an diese Empfehlung nicht ganz hält und weniger Kommentare verwendet...)
\quoteoff
Hallo Deltastelle, woher hast du diese Empfehlung? Insbesondere bei trivialen Funktionen und bei Boilerplate-code sind Kommentare doch eher Ballast, als das sie helfen.
Wenn man eine Bibliothek entwickelt, sieht das natürlich anders aus.
\quoteoff
Ich muss mal schauen, wo ich den Tipp herhabe.
Eventuell Horstman "Computing Concept with Java 2" - ich muss noch mal schauen...
Viele Grüße
Ronald
|
Profil
|
| Bekell hat die Antworten auf ihre/seine Frage gesehen. | | Bekell wird per Mail über neue Antworten informiert. |
|
All logos and trademarks in this site are property of their respective owner. The comments are property of their posters, all the rest © 2001-2023 by Matroids Matheplanet
This web site was originally made with PHP-Nuke, a former web portal system written in PHP that seems no longer to be maintained nor supported. PHP-Nuke is Free Software released under the GNU/GPL license.
Ich distanziere mich von rechtswidrigen oder anstößigen Inhalten, die sich trotz aufmerksamer Prüfung hinter hier verwendeten Links verbergen mögen.
Lesen Sie die
Nutzungsbedingungen,
die Distanzierung,
die Datenschutzerklärung und das Impressum.
[Seitenanfang]
|
Home / Seite ohne Frame
Wie unterstütze ich den Matheplaneten mit Geld?
