Wie lang oder kurz sollen Options-namen sein? (gelöst) (Allgemeines zu Perl) - Perl-Community.de

Start · Board · Anwendungen/Programme/Skripte in Perl · Allgemeines zu Perl

2024-04-28 22:20:47
Europe/Berlin
Einloggen (Registrieren)
- Einstellungen
- Statistics
Jemand zu Hause?
0 Benutzer online
1 Gast

[thread]17548[/thread]

submit to reddit

Wie lang oder kurz sollen Options-namen sein? [gelöst]

[gelöst]

Tags: perl5 Ähnliche Threads

Leser: 22

Articles: hide open all | hide show old branches

+20 replies
Kuerbis

2012-07-08 18:02
User since
2011-03-20
938 Artikel
BenutzerIn
Hallo!

Wenn bei einer Funktion Optionen als Hash-referenz übergeben werden, sollten die Namen der Optionen eher kurz und leicht zu merken und angenehm zu schreiben sein oder besser lang und dafür informativ?
Code (perl): (dl )

function( ..., { kurz1 => ..., kurz2 => ... } );
oder
Code (perl): (dl )

function( ..., { lang_lang_eins => ..., lang_zwei => ... } );
- murphy
  
  2012-07-08 18:26
  
  User since
  2004-07-19
  1776 Artikel
  HausmeisterIn
  
  Die richtige Balance muss man halt finden :-)
  
  Ich würde es auch ein wenig davon abhängig machen, wie oft eine Option voraussichtlich verwendet wird: Was der Nutzer der Schnittstelle dauernd schreibt, sollte kurz und prägnant sein, denn die genaue Bedeutung wird man sich ohnehin merken müssen. Bei seltener verwendeten Optionen stören lange Namen weniger und können außerdem hilfreich sein um gleich die Funktion zu erkennen.
  When C++ is your hammer, every problem looks like your thumb.
- rosti
  
  2012-07-08 19:25
  
  User since
  2011-03-19
  3197 Artikel
  BenutzerIn
  
  In der Funktion/Methode sollte gut zu sehen sein, welche Namen der Hash-Referenz Verwendung finden, dabei ists egal ob die kurz oder lang oder leicht oder schwer zu merken sind.
  
  http://rolfrost.de/perlbase.htm?id=155#155
  
  --Rosti
- moritz
  
  2012-07-08 22:27
  
  User since
  2007-05-11
  923 Artikel
  HausmeisterIn
  
  So kurz wie nötig, so lang wie nötig.
  
  Es hängt von vielen Faktoren ab, am wichtigsten ist, dass der Benutzer es sich gut merken kann. Daher ist Konsistenz wichtiger als Länge.
  Perl 6 - Perls Zukunft
- Raubtier
  
  2012-07-09 11:35
  
  User since
  2012-05-04
  1054 Artikel
  BenutzerIn
  
  Um auch noch mal meine Meinung abzugeben:
  
  Wenn dein Programm nur wenige Parameter nimmt, dann nimm kurze Namen, also z.B. nur einen Buchstaben. Sollten viele Parameter übergeben werden, oder solche, die nur selten gebraucht werden, empfehlen sich lange Namen.
  
  Ansonsten stimmt ich den anderen Antworten hier zu.
- +11 replies
- Kuerbis
  
  2012-07-09 15:34
  
  User since
  2011-03-20
  938 Artikel
  BenutzerIn
  
  Ist undef als Optionsname ok oder eher ungünstig?
  - +9 replies
  - bianca
    
    2012-07-09 15:54
    
    User since
    2009-09-13
    6977 Artikel
    BenutzerIn
    
    Das ist ein Schlüsselwort und deshalb reserviert.
    10 print "Hallo"
    20 goto 10
    - +8 replies
    - murphy
      
      2012-07-09 16:02
      
      User since
      2004-07-19
      1776 Artikel
      HausmeisterIn
      
      Die Schlüssel in einem Hash sind beliebige Zeichenketten, reservierte Schlüsselworte gibt es da nicht. Beispiel:
      
      Code (perl): (dl )
      
      1 2
      
      use Data::Dumper; print Dumper { undef => 42 };
      
      Ausgabe:
      
      Code: (dl )
      
      1 2 3
      
      $VAR1 = { 'undef' => 42 };
      
      Wie sinnvoll es ist, als Optionsname etwas zu verwenden, was an anderer Stelle in der Sprache bereits mit Bedeutung belegt ist, darüber kann man sich natürlich streiten.
      When C++ is your hammer, every problem looks like your thumb.
      - +7 replies
      - Gast Muffi
        
        2012-07-11 14:55
        
        2012-07-09T14:02:19 murphy
        Die Schlüssel in einem Hash sind beliebige Zeichenketten, reservierte Schlüsselworte gibt es da nicht.
        
        Naja, so einfach ist es auch nicht.
        
        Code (perl): (dl )
        
        my %toilet_strings = (00 => 'WC');
        
        ergibt was anderes als '00' => 'WC'.
        
        Von daher hätt ich mir jetzt auch nicht höhere Beträge wetten traun, dass nicht vielleicht doch '' => 42 rauskommt
        Last edited: 2012-07-11 15:04:42 +0200 (CEST)
        
        +6 replies
        
        Raubtier
        
        2012-07-11 16:11
        
        User since
        2012-05-04
        1054 Artikel
        BenutzerIn
        
        Das ist aber kein Problem der Übergabe eines "00" Parameters an ein Perl-Programm, sondern einfach ein Fehler desjenigen, der in das Perl-Programm schreibt.
        
        00 ist eine Zahl. Wenn du irgendwas mit Leerzeichen hast, geht das auch nicht. Nur Barewords werden hier einfach so als Strings interpretiert.
        
        +5 replies
        
        Gast Muffi
        
        2012-07-11 16:19
        
        Ja. Perl nimmt das was links vom => steht und sieht das NICHT als String, sondern strinigifziert es.
        Das könnte Perl konsequenterweise genauso mit undef tun und es käme wohl '' raus.
        
        +4 replies
        
        pq
        
        2012-07-11 16:21
        
        User since
        2003-08-04
        12208 Artikel
        Admin1
        
        nicht ganz, das stringifizieren passiert nur mit barewords, wie schon gesagt.
        trotzdem finde ich auch, ein undef => ... könnte verwirrend sein und als leser könnte man glauben, der autor hätte sich vertan.
        Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. -- Damian Conway in "Perl Best Practices"
        lesen: Wie frage ich & perlintro brian's Leitfaden für jedes Perl-Problem
        
        +3 replies
        
        bianca
        
        2012-07-11 16:46
        
        User since
        2009-09-13
        6977 Artikel
        BenutzerIn
        
        2012-07-11T14:21:36 pq
        trotzdem finde ich auch, ein undef => ... könnte verwirrend sein und als leser könnte man glauben, der autor hätte sich vertan.
        
        Danke. Genau so meinte ich es auch.
        Ist ja nicht so als hätte man keine anderen Möglichkeiten :)
        10 print "Hallo"
        20 goto 10
        
        +2 replies
        
        Raubtier
        
        2012-07-11 16:48
        
        User since
        2012-05-04
        1054 Artikel
        BenutzerIn
        
        Wo ist das Problem, ich verstehe es immer noch nicht. Auch ich gebe gerne zu, dass das etwas unübersichtlich ist. Warum dann nicht %h = ("undef" => irgendwas) schreiben? Das hat rein GAR NICHTS damit zu tun, ob man einen Kommandozeilenswitch mit dem Namen "undef" haben sollte oder nicht.
        
        bianca
        
        2012-07-11 17:21
        
        User since
        2009-09-13
        6977 Artikel
        BenutzerIn
        
        2012-07-11T14:48:20 Raubtier
        Wo ist das Problem, ich verstehe es immer noch nicht.
        
        Wenn es für dich keines ist ist ja OK.
        Aber Kürbis ist kein Routinier sondern Anfänger in Perl. Und damit macht er sich m.E. das Leben unnötig schwer.
        10 print "Hallo"
        20 goto 10
  - rosti
    
    2012-07-09 17:09
    
    User since
    2011-03-19
    3197 Artikel
    BenutzerIn
    
    2012-07-09T13:34:32 Kuerbis
    Ist undef als Optionsname ok oder eher ungünstig?
    
    Fallstudie: Angenommen, Du hast eine Hashreferenz, die erst mit dem Aufruf einer subfunction einen oder mehrere Werte bekommt. Dann darf ein Wert bei der Übergabe auch undef sein. Allerdings sollte ein Programm, was so tut, gut dokumentiert sein!
    
    --Rosti
- +4 replies
- Kuerbis
  
  2012-07-11 11:46
  
  User since
  2011-03-20
  938 Artikel
  BenutzerIn
  
  Danke für die Beiträge. Im erwähnten Fall werde ich es mit undef versuchen.
  - +3 replies
  - bianca
    
    2012-07-11 12:27
    
    User since
    2009-09-13
    6977 Artikel
    BenutzerIn
    
    2012-07-11T09:46:09 Kuerbis
    Danke für die Beiträge. Im erwähnten Fall werde ich es mit undef versuchen.
    
    Warum benutzt du aus allen Vorschlägen ausgerechnet das am wenigsten geeignete?
    undef ist weder sprechend noch völlig bedenkenlos.
    Es ist in anderen Zusammenhängen ein reserviertes Wort der Perl Syntax und führt in diesem Zusammenhang sicherlich nicht zur Klarheit des Codes. Warum machst du es dir und anderen selbst schwer?
    10 print "Hallo"
    20 goto 10
    - Raubtier
      
      2012-07-11 13:40
      
      User since
      2012-05-04
      1054 Artikel
      BenutzerIn
      
      Warum ist undef nicht bedenkenlos? Ich könnte mir schon Fälle vorstellen, wo es sinnvoll wäre, eine Option mit genau diesem Namen zu haben. Wofür Kuerbis genau diese Option habe will, ist ja nicht bekannt.
      
      Auch dass "undef" in Perl reserviert ist, macht doch nichts - als Option ist es doch nur ein simpler String. Man denke auch an das Programm "find", das hat auch eine Option namens "print". Würdest du die Option umbenennen, solltest du find in Perl nachbauen wollen?
    - Gast Muffi
      
      2012-07-11 13:40
      
      Ich denke auch, selbst wenn es nicht bei 90% der Codeleser zu stirnrunzeln führen würde, es kein wirklich sprechender Name ist.
      wie wärs denn mit:
      - allow_undef
      - can_return_undef
      - undef_on_error
      
      oder wasweissich was du damit sagen willst.
      Last edited: 2012-07-11 13:55:33 +0200 (CEST)

View all threads created 2012-07-08 18:02.