Convert type comments to JSDoc format

[tojump]

Many code editors support JSDoc comments, displaying their content while showing suggestions.

For example in src/api/chia/consensus/block_record.ts, if we replace:

export type BlockRecord = {
  header_hash: bytes32; // bytes32
  prev_hash: bytes32; // bytes32  # Header hash of the previous block
  ...

with

export type BlockRecord = {
  header_hash: bytes32; // bytes32
  /**
   * Header hash of the previous block
   */
  prev_hash: bytes32; // bytes32
  ...

or

export type BlockRecord = {
  header_hash: bytes32; // bytes32
  /** Header hash of the previous block */
  prev_hash: bytes32; // bytes32
  ...

Then the emitted declaration file will retain the JSDoc comment and we will get in-editor suggestions.

Since I don't know whether you extract the types from the chia code base manually or with a script, I am posting this as an issue first, but I will gladly contribute a PR in either case.

[ChiaMineJP]

I manually check the chia code one by one.
JSDoc comments are good if what they say are correct and easy to understand.
What do you think should be a good source of those JSDocs?

[tojump]

To begin with, I was thinking to use the existing single-line comments appended after the data type property names in the chia-blockchain source code, which you helpfully copied over along with names of the original python types (which would also be helpful).

Then if we want to add docs to the API endpoint functions and their parameters, we can parse the descriptions in chia-docs:
https://github.com/Chia-Network/chia-docs/blob/main/docs/12rpcs/full_node_api.md
https://github.com/Chia-Network/chia-docs/blob/main/docs/12rpcs/did_rpcs.mdx
https://github.com/Chia-Network/chia-docs/blob/main/docs/12rpcs/nft_rpcs.mdx