freakimkaefig / Music-XML-Analyzer

Music XML Analyzer
http://freakimkaefig.github.io/Music-XML-Analyzer/
MIT License
15 stars 4 forks source link

Code cleaning #76

Closed led13714 closed 9 years ago

freakimkaefig commented 9 years ago

ggf methoden ordentlich kommentieren:

Javascript

/**
 * Method description
 *
 * @param {datatype}    name    description
 *
 * @return {datatype}    name    description
 */
bla123 = function(name) { ... }

http://en.wikipedia.org/wiki/JSDoc


PHP

/**
 * Helper function to calculate the starting measures number
 *
 * @param   \DOMNode    $part     The \DOMNode element for the music xml part
 * @param   int         $start   The start notes number (inside the part)
 *
 * @return  int         Number of the measure where the extract should start
 *
 */
private function calculateStartExtract($part, $start) { ... }

http://de.wikipedia.org/wiki/PHPDoc http://www.phpdoc.org/docs/latest/index.html

led13714 commented 9 years ago
led13714 commented 9 years ago
matTailor commented 9 years ago

@luggi: am besten kommentierst du no die methoden beim dashboard model. Denke des kannst du besser erklären weistas ja a gmacht hast ;)

matTailor commented 9 years ago

patternModel & resultModel cleaned!

led13714 commented 9 years ago