{"id":20812760,"url":"https://github.com/feast107/jsoncomment","last_synced_at":"2025-12-25T02:48:37.552Z","repository":{"id":115448049,"uuid":"606829710","full_name":"feast107/JsonComment","owner":"feast107","description":"Auto generate json document with comments using attributes","archived":false,"fork":false,"pushed_at":"2023-03-05T12:35:38.000Z","size":423,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-18T14:54:48.753Z","etag":null,"topics":["autogenerated","comments","csharp","json","netstandard20","sourcegenerator"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/feast107.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-26T17:34:28.000Z","updated_at":"2023-03-05T12:36:05.000Z","dependencies_parsed_at":"2023-09-06T06:15:19.423Z","dependency_job_id":null,"html_url":"https://github.com/feast107/JsonComment","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feast107%2FJsonComment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feast107%2FJsonComment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feast107%2FJsonComment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feast107%2FJsonComment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/feast107","download_url":"https://codeload.github.com/feast107/JsonComment/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243159179,"owners_count":20245675,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autogenerated","comments","csharp","json","netstandard20","sourcegenerator"],"created_at":"2024-11-17T20:58:05.699Z","updated_at":"2025-12-25T02:48:37.507Z","avatar_url":"https://github.com/feast107.png","language":"C#","readme":"# JsonComment\n能够通过注解自动生成文档注释的基于 `.NET Standard 2.0` 的代码分析器\n\n:construction: :construction: **施工中注意——仍有bug** :construction: :construction:\n\n# Effect：\n![](/doc/Example.png)\n\n# Start\n+ 引用程序集之后添加为 \n    ```json\n    OutputItemType=\"Analyzer\"\n    ```\n    ``` xml\n    \u003cItemGroup\u003e\n        \u003cProjectReference Include=\"path\\to\\Feast.JsonComment.csproj\" OutputItemType=\"Analyzer\" /\u003e\n    \u003c/ItemGroup\u003e\n    ```\n    由于需要引用包中的内容，请忽略 `ReferenceOutputAssembly` 项或将其置为 `true` \n    ``` json\n    ReferenceOutputAssembly=\"true\"\n    ```\n+ 在你需要生成注释的类型上添加 `JsonComment`\n    ``` c#\n    using Feast.JsonComment;\n\n    [JsonComment]\n    public partial class MyModel{\n        public int Id { get; init; } \n        public string Name { get; set; } \n    } \n    ```\n    + :warning: **类型需要携带 `partial` 关键字**\n    + :warning: **类型的其他注释将会覆盖该注释**\n    + :ok_hand: 本程序集不会对任何类型进行增改\n\n\n+ 在你的程序中调用 `JsonComment.Generate()`\n    ``` c#\n    internal class Program\n    {\n        static void Main(string[] args)\n        {\n            JsonComment.Generate();\n        }\n    }\n    ```\n    文档将会生成在类型声明文件所在的目录下，目录下批量的源文件会整合到一个文档文件中\n\n\n# Preview\n+ :grey_exclamation: 泛型\u003c\u003e\n+ :construction: 初始值项的设定\n+ :construction: 如果尽可能的避免生成外部文档，但这会要求在分析时生成JSON数据，以及继承关系分析上的困难","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffeast107%2Fjsoncomment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffeast107%2Fjsoncomment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffeast107%2Fjsoncomment/lists"}