Forum Discussion

BenoitB's avatar
BenoitB
Community Hero
5 years ago

Share your writing guidelines on scripting - Focus on method writing

Hello all,   Please share and discuss about your writing guidelines focused here on your standard way of building a script method.   Below i give you mine, French inside. This is a standard guid...
Scripting
TechCorner
TanyaYatskovska's avatar
TanyaYatskovska
SmartBear Alumni (Retired)
5 years ago

Thanks for sharing this, BenoitB. I've added this great topic to the TechConer area.

Several questions:

  • I don't see any comments inside a function. Do you explain all the actions you do in the code before the function? Sorry, perhaps, it's listed in French, but I don't understand.
  • Have you ever used any code documentation tools? What was your experience?

 

  • BenoitB's avatar
    BenoitB
    Community Hero
    5 years ago

    Hello TanyaYatskovska 

     

    About comments;  yes it's true you should comment when it's NOT trivial only. But as i prepare another post on General guidelines for scripting i've not speak about comments here. It's more on what's your standard way of building a robust and clean function.

     

    About documentation tools, i use a nodeJs jsdoc module that i've tweaked, a sample of the result is here:

     

    i'll write another post on this subject later, it's planned ;)