Whole Tomato Software Forums
Whole Tomato Software Forums
Main Site | Profile | Register | Active Topics | Members | Search | FAQ
User name:
 Password:
Save Password
Forgot your password?

 All Forums
 Visual Assist
 Feature Requests
 Document method/class/etc		  New Topic  Reply to Topic
 Printer Friendly
Author Previous Topic Topic Next Topic  

Uniwares
Tomato Guru

Portugal
2322 Posts
Posted - Aug 18 2020 :  10:10:10 AM  Show Profile  Reply with Quote
Just found what I wish VA would do: https://marketplace.visualstudio.com/items?itemName=jinyafeng.DocumentationAssistant

Creates pretty nifty documentation with auto derived content from member name and type.

accord
Whole Tomato Software

United Kingdom
3287 Posts
Posted - Aug 18 2020 :  3:56:20 PM  Show Profile  Reply with Quote
While it looks fancy, it doesn't really add any additional information which isn't immediately obvious from the method signature, in my opinion.

Now, risking to be a bit futuristic, this is what I would imagine to be generated by a neural network that was trained on a huge amount of method body and their comment pairs. GPT-3 and other approaches show promise with similar tasks, but this is just an idea, not a promise that it will be implemented Since it's not only highly experimental at this point but also requires unreal amount of computational capacity for the training.
Edited by - accord on Aug 18 2020 3:58:49 PM
Go to Top of Page

Uniwares
Tomato Guru

Portugal
2322 Posts
Posted - Aug 18 2020 :  4:50:07 PM  Show Profile  Reply with Quote
Should not be too hard to analyze a method and create the documentation from this info. Would be typical VA functionality.
Guess its out with the next release, right?
Go to Top of Page

feline
Whole Tomato Software

United Kingdom
19024 Posts
Posted - Aug 19 2020 :  10:43:53 AM  Show Profile  Reply with Quote
Urg, considering this from the support point of view, when you start getting variables created on the fly with macros, lots of one character variable names, etc, I wonder how easy it would be to break this. That's before you even start with the same name used for different things in different scopes!

Reminds me of the wonderful idea that good code does not require comments, since it is clear, and comments are to explain things that are not obvious. Still not sold on this idea, but I like the theory
zen is the art of being at one with the two'ness
Go to Top of Page

accord
Whole Tomato Software

United Kingdom
3287 Posts
Posted - Aug 26 2020 :  3:54:55 PM  Show Profile  Reply with Quote
I have mentioned that GPT-3 might be able to help with this and someone who was lucky to get an early access is already playing around with this with surprisingly good results:
https://twitter.com/amasad/status/1285789362647478272
Go to Top of Page

Uniwares
Tomato Guru

Portugal
2322 Posts
Posted - Aug 26 2020 :  3:58:14 PM  Show Profile  Reply with Quote
When? VA2390?
Go to Top of Page

feline
Whole Tomato Software

United Kingdom
19024 Posts
Posted - Aug 27 2020 :  07:56:59 AM  Show Profile  Reply with Quote
Thank you for volunteering to support this new and exciting feature
zen is the art of being at one with the two'ness
Go to Top of Page

Uniwares
Tomato Guru

Portugal
2322 Posts
Posted - Aug 27 2020 :  08:45:56 AM  Show Profile  Reply with Quote
Can always count on me!
Go to Top of Page
  Previous Topic Topic Next Topic  
 New Topic  Reply to Topic
 Printer Friendly
Jump To:
© 2023 Whole Tomato Software, LLC Go To Top Of Page
Snitz Forums 2000