documentation

Node.js

jsdoc

  1. /**
  2.  * Creates a new Person.
  3.  * @class
  4.  * @example
  5.  * const person = new Person('bob')
  6.  */
  7. class Person {
  8.   /**
  9.    * Create a person.
  10.    * @param {string} [name] - The person's name.
  11.    */
  12.   constructor(name) {
  13.     this.name = name
  14.   }
  16.   /**
  17.    * Get the person's name.
  18.    * @return {string} The person's name
  19.    * @example
  20.    * person.getName()
  21.    */
  22.   getName() {
  23.     return this.name
  24.   }
  26.   /**
  27.    * Set the person's name.
  28.    * @param {string} name - The person's name.
  29.    * @example
  30.    * person.setName('bob')
  31.    */
  32.   setName(name) {
  33.     this.name = name
  34.   }
  35. }

Go

godoc

person.go

  1. package person
  3. import "fmt"
  5. // Person is the structure of a person
  6. type Person struct {
  7.     name string
  8. }
  10. // NewPerson creates a new person. Takes in a name argument.
  11. func NewPerson(name string) *Person {
  12.     return &Person{
  13.         name: name,
  14.     }
  15. }
  17. // GetName returns the person's name
  18. func (p *Person) GetName() string {
  19.     return p.name
  20. }
  22. // SetName sets the person's name
  23. func (p *Person) SetName(name string) string {
  24.     return p.name
  25. }

person_test.go

  1. // Example of creating a new Person.
  2. func ExampleNewPerson() {
  3.     person := NewPerson("bob")
  4.     _ = person
  5. }
  7. // Example of getting person's name.
  8. func ExamplePerson_GetName() {
  9.     person := NewPerson("bob")
  10.     fmt.Println(person.GetName())
  11.     // Output: bob
  12. }
  14. // Example of setting person's name.
  15. func ExamplePerson_SetName() {
  16.     person := NewPerson("alice")
  17.     person.SetName("bob")
  18. }

<!—