Versions Compared

Old Version 4

changes.mady.by.user Jonathan Muse

Saved on

compared with

New Version Current

changes.mady.by.user Jonathan Muse

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • A brief description of what the routine function does.

  • A description of each parameter and a description of what each parameter represents.

Code Block
/**
* Lists all the files in a given directory tree. 
* @param dirName - The path of directory to search
* @param excludes - A list of directories or files to exclude from results
* @return The list of files found in the directory
*/
function directoryFiles(string dirName, string[] excludes) {
  // rest of routinefunction here
}

Conclusion

For a complete explanation of commenting, see this Oracle page on commenting code.

...