Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl-Sensitive Sunglasses

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
Interesting discussion, but apart from (and above, really) the syntax (incl. comments) impact on semantics, I find that code design is of superior importance for maintainability; Consider design principles such as Separation of Concerns, Orthogonality, Extensibility, Testability (quote On-Writing-Maintainable-Code) :

Can I find the code related to the problem or the requested change? Go +od Naming, High Cohesion, Single Responsibility Principle, Separation + of Concerns Can I understand the code? Good Naming, Composed Method, The Principle + of Least Surprise, Can You See The Flow of the Code?, Encapsulation Is it easy to change the code? Don't Repeat Yourself, Wormhole Anti-Pa +ttern, Open Closed Principle Can I quickly verify my changes in isolation? Loose Coupling, High Coh +esion, Testability Can I make the change with a low risk of breaking existing features? L +oose Coupling, High Cohesion, Open Closed Principle, Testability Will I know if and why something is broken? Fail Fast

Best regards,
Allan Dystrup

In reply to Re: Code Maintainability by ady
in thread Code Maintainability by mpeever

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

  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or or How to display code and escape characters are good places to start.
Log In?

What's my password?
Create A New User
Domain Nodelet?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others pondering the Monastery: (1)
As of 2022-10-01 02:37 GMT
Find Nodes?
    Voting Booth?
    I prefer my indexes to start at:

    Results (126 votes). Check out past polls.