Every file should have a string at the top that says what the file/class is for/contains.
Every description of a method/function should explain what are the expected types of data you'll take as input and give as output. It's helpful in a weakly typed language to make that explicit in the documentation, since it is 100% certain your code is expecting it.
Every file should have a string at the top that says what the file/class is for/contains.
Every description of a method/function should explain what are the expected types of data you'll take as input and give as output. It's helpful in a weakly typed language to make that explicit in the documentation, since it is 100% certain your code is expecting it.