0

I am using jsdocs for commenting my code. I am a bit puzzled how to comment properly.

for example, I have such interfaces:

export interface IModal {
  onClose: () => void;
  isOpen: boolean;
  id: number;
  deleteSelectedId: () => void;
  isDepartment: boolean;
}

export interface IAccountsValue {
  name: string;
  surname: string;
  middlename: string;
  department: string;
  id: number | null;
}


export interface IGetValue {
  name: string;
  value: string;
  id: number;
}

How to write comments for that properly ?

Anton
  • 65
  • 7
  • 1
    What do you mean _"properly"_? What information are you hoping to add, for whose benefit? – jonrsharpe Nov 14 '22 at 16:00
  • "Properly" I mean, as I know, there are specific rules how to write comments. And I wanted to find out how to follow all these rules . For example, if it is function, comments jsdocs have to look certain way and so on – Anton Nov 14 '22 at 16:22
  • What specific issue/s are you facing that the JSDoc docs don't cover? – Dave Newton Nov 14 '22 at 16:35

0 Answers0