Hi all,
I wrote a class and in VS Code, DScanner says that the class is undocumented. How can i document a class ?

On Thursday, 14 May 2020 at 06:05:00 UTC, Vinod K Chandran wrote:
> Hi all,
> I wrote a class and in VS Code, DScanner says that the class is undocumented. How can i document a class ?

Never mind, i found the answer myself. Just like in dot net, i added triple forward slash comment and problem solved.

On Thursday, 14 May 2020 at 06:08:17 UTC, Vinod K Chandran wrote:
> On Thursday, 14 May 2020 at 06:05:00 UTC, Vinod K Chandran wrote:
>> Hi all,
>> I wrote a class and in VS Code, DScanner says that the class is undocumented. How can i document a class ?
>
> Never mind, i found the answer myself. Just like in dot net, i added triple forward slash comment and problem solved.

If you plan to publish your code to dub, consider actually documenting it or marking it private/package so it won't appear as an undocumented symbol.

On Thursday, 14 May 2020 at 06:08:17 UTC, Vinod K Chandran wrote:
> On Thursday, 14 May 2020 at 06:05:00 UTC, Vinod K Chandran wrote:
>> Hi all,
>> I wrote a class and in VS Code, DScanner says that the class is undocumented. How can i document a class ?
>
> Never mind, i found the answer myself. Just like in dot net, i added triple forward slash comment and problem solved.

Also see https://dlang.org/spec/ddoc.html for more info on DDoc.

FWIW you can also disable the warning by adding the following to VSCode's settings.json:

"dscanner.ignoredKeys": [
     "dscanner.style.undocumented_declaration"
]

to your settings.json. I do that since I usually find the warning distracting while implementing new methods, where I only document things once I'm happy with the implementation and all the warnings about missing docs usually distract me from more important warnings during that phase.

On Thursday, 14 May 2020 at 11:25:48 UTC, Cogitri wrote:
> On Thursday, 14 May 2020 at 06:08:17 UTC, Vinod K Chandran wrote:
>> [...]
>
> Also see https://dlang.org/spec/ddoc.html for more info on DDoc.
>
> FWIW you can also disable the warning by adding the following to VSCode's settings.json:
>
> "dscanner.ignoredKeys": [
>      "dscanner.style.undocumented_declaration"
> ]
>
> to your settings.json. I do that since I usually find the warning distracting while implementing new methods, where I only document things once I'm happy with the implementation and all the warnings about missing docs usually distract me from more important warnings during that phase.

Thanks for VS Code settings. Will add it to my VS Code.

On Thursday, 14 May 2020 at 08:02:28 UTC, Dennis wrote:
> On Thursday, 14 May 2020 at 06:08:17 UTC, Vinod K Chandran wrote:
>> On Thursday, 14 May 2020 at 06:05:00 UTC, Vinod K Chandran wrote:
>>> Hi all,
>>> I wrote a class and in VS Code, DScanner says that the class is undocumented. How can i document a class ?
>>
>> Never mind, i found the answer myself. Just like in dot net, i added triple forward slash comment and problem solved.
>
> If you plan to publish your code to dub, consider actually documenting it or marking it private/package so it won't appear as an undocumented symbol.

Thanks for the reply. :)

On Thursday, 14 May 2020 at 08:02:28 UTC, Dennis wrote:
> On Thursday, 14 May 2020 at 06:08:17 UTC, Vinod K Chandran wrote:
>> On Thursday, 14 May 2020 at 06:05:00 UTC, Vinod K Chandran wrote:
>>> Hi all,
>>> I wrote a class and in VS Code, DScanner says that the class is undocumented. How can i document a class ?
>>
>> Never mind, i found the answer myself. Just like in dot net, i added triple forward slash comment and problem solved.
>
> If you plan to publish your code to dub, consider actually documenting it or marking it private/package so it won't appear as an undocumented symbol.

Thanks. But i am not using dub because my code only runs with "dmd -i".