jsDocExample.js
上传用户:shen332233
上传日期:2021-09-03
资源大小:7478k
文件大小:2k
源码类别:

Ajax

开发平台:

Java

  1. /** 
  2.  * @fileoverview This file is an example of how JSDoc can be used to document
  3.  * JavaScript. 
  4.  *
  5.  * @author Ryan Asleson
  6.  * @version 1.0 
  7.  */
  8. /**
  9.  * Construct a new Person class.
  10.  * @class This class represents an instance of a Person.
  11.  * @constructor 
  12.  * @param {String} name The name of the Person.
  13.  * @return A new instance of a Person.
  14. */
  15. function Person(name) {
  16.     /** 
  17.      * The Person's name
  18.      * @type String
  19.     */
  20.     this.name = name;
  21.     /**
  22.      * Return the Person's name. This function is assigned in the class
  23.      * constructor rather than using the prototype keyword.
  24.      * @returns The Person's name
  25.      * @type String 
  26.     */
  27.     this.getName = function() {
  28.         return name;
  29.     }
  30. }
  31. /**
  32.  * Construct a new Employee class.
  33.  * @extends Person
  34.  * @class This class represents an instance of an Employee.
  35.  * @constructor 
  36.  * @return A new instance of a Person.
  37. */
  38. function Employee(name, title, salary) {
  39.     this.name = name;
  40.     /** 
  41.      * The Employee's title
  42.      * @type String
  43.     */
  44.     this.title = title;
  45.     /** 
  46.      * The Employee's salary
  47.      * @type int
  48.     */
  49.     this.salary = salary;
  50. }
  51. /* Employee extends Person */
  52. Employee.prototype = new Person();
  53. /**
  54.  * An example of function assignment using the prototype keyword. 
  55.  * This method returns a String representation of the Employee's data.
  56.  * @returns The Employee's name, title, and salary 
  57.  * @type String
  58. */
  59. Employee.prototype.getDescription = function() {
  60.     return this.name + " - " 
  61.         + this.title + " - "
  62.         + "$" + this.salary;
  63. }