Fellow monks,

I have decided to start documenting my project at last and was hoping to use UML class diagrams for visualization of class relations in my code. But I just can't figure up how I should write perl function prototypes and data types into UML class diagram.

Let's have method foo: 

sub foo {
    my ($self,$date,$message,$opt_args) = @_;
    .....
    return $sucess;
}

[download]
Which one of these should I use?
  1. +foo(date: scalar, message: scalar, opt_args: hashref): scalar
  2. +foo($date: Date, $message: String, $opt_args: Hash): boolean
  3. +foo($date: String, $message: String, $opt_args: \Hash): boolean
... or none of these, any of these, combination of these?

And things starts to get even more weird when 'standard' OO constructor calling convention takes place: 

sub new {
    my ($class,%args) = @_;
    ...
    my $foobar = $args{foo} . $args{bar}; # Whatever
    ...
}

[download]
Should this be written as new(%args: Hash): \Class or new(foo: String, bar: String): Class or just new(args: Hash)?

Please, help poor confused monk to find a stream of light in darkness. Any suggestion appreciated.

In reply to Perl UML conventions by gildir

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.