andreinitescu / IconFont2Code

Generate C# class with constant fields for the icons in your font
277 stars 37 forks source link

Suggested Feature #11

Closed alanhoman closed 4 years ago

alanhoman commented 4 years ago

This tool has been very helpful! Thank you for your great work. I had one simple suggestion and that is to automatically add a comment in the C# generated code as shown below.

//Generated by IconFont2Code: https://andreinitescu.github.io/IconFont2Code/ static class IconFont { ... }

andreinitescu commented 4 years ago

Happy to hear it's been helpful. Just curious, how would adding that comment be useful?

alanhoman commented 4 years ago

Hi Andrei,

This would help in 2 ways:

  1. It would document how this code was generated so another developer could see the source and know how to refresh it or create a new one when necessary. I would manually add this to the code in any case for the same reason.
  2. If someone uses your tool and adds their code to GitHub, other users will see the comment and know how the code was generated (so they could do it themself for future updates). I noticed your code in https://github.com/davidortinau/Xappy and had to dig around to figure out how they generated this code. If the comment had been there, I would have known immediately.

Thanks, Alan

From: Andrei Nitescu notifications@github.com Sent: Thursday, July 16, 2020 9:25 PM To: andreinitescu/IconFont2Code IconFont2Code@noreply.github.com Cc: Alan Homan ahoman@hw.com; Author author@noreply.github.com Subject: Re: [andreinitescu/IconFont2Code] Suggested Feature (#11)

Happy to hear it's been helpful. Just curious, how would adding that comment be useful?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/andreinitescu/IconFont2Code/issues/11#issuecomment-659838983, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AAQVL6XTMAZ2KPVL6MRSAB3R37G77ANCNFSM4O5NLUHQ.

andreinitescu commented 4 years ago

@alanhoman Done! Thanks for reply