search

halfnelson / nativescript-source-to-jsx-def

Walk nativescript source to generate JSX types for `svelte-type-checker-vscode`
Other
4 stars 1 forks source link

add comment next to each property marking the source #13

Open halfnelson opened 4 years ago

halfnelson commented 4 years ago

It would be good to know where each property came from, (maybe an option to enable debug) we could add //syntheticEvent, //dynamic property, //extra property from -common class

shirakaba commented 4 years ago

I think at least toggling this based on a flag would indeed be useful.

There are some use-cases to consider:

1) providing us debug as to where each thing came from; 2) providing users with some succinct typings (few to no comments so that it's quick and easy to navigate the typings file); 3) providing users with some verbose typings (extract the documentation comments from NativeScript core);

A good middle-ground would be to add a /** @see link */ atop each interface to allow users to jump to the corresponding file and read the detailed comments (I'm not sure whether @see supports file-system links, but that would be awesome). Although since the interfaces are synthesised from one or more files, maybe the best that could be done would be to produce several @see statements on different lines.

Whether to add comments to each individual field within the interface is another question. Again, if this were toggled by a flag, we could be flexible here.