LearnTeachCode / LTC_game_jam

Learn Teach Code group game jam November 2018
6 stars 8 forks source link

Doc Strings #43

Open Marsha331 opened 5 years ago

Marsha331 commented 5 years ago

Use JS doc for docstrings

Ean's example for his const thaiFood = (SideOrder)

\** 
    * @param {object} sideOrder : Name of food item to check availability for.
    * @returns {boolean} 
*/
const thaiFood = (siderOrder) => {
    var isAvailbile = (sideOrder.isAvailible === true);
    return isAvailible
}

Edit (Ean): correcting syntax

E-A-N commented 5 years ago

Hey @sugarsyntax @qwertypie90 you all are doing a great job with the doc strings! Some notes: