Documentation 内部源代码文档-FiM&x2B+;

Documentation 内部源代码文档-FiM&x2B+;,documentation,programming-languages,comments,javadoc,code-documentation,Documentation,Programming Languages,Comments,Javadoc,Code Documentation,FiM++程序的结构要求以字母结尾,并以特定方式显示代码作者的姓名 Dear Princess Celestia and Stack Exchange and String: A Sample: ... Your faithful student, Southpaw Hare! 根据,关键字“您忠实的学生”(包括逗号,但不包括下面的空格)用作类定义的结束标记,下面的名称是没有语法效果的注释 作者自动包含在每个文件中(如果不是严格要求的话),这一事实让我怀疑它是否可以用作类似于Java文

FiM++程序的结构要求以字母结尾,并以特定方式显示代码作者的姓名

Dear Princess Celestia and Stack Exchange and String: A Sample:
    ...
Your faithful student, Southpaw Hare!
根据,关键字“您忠实的学生”(包括逗号,但不包括下面的空格)用作类定义的结束标记,下面的名称是没有语法效果的注释

作者自动包含在每个文件中(如果不是严格要求的话),这一事实让我怀疑它是否可以用作类似于Java文档的可解释文档的形式。换句话说,其他程序或编辑器将能够解析出这个名称并以某种方式使用它

  • 此类基于评论的内部文档的要求是什么?在这种特殊类型的语法中是否有任何东西会导致问题

  • 关键词是否足以适应主题?我突然想到,如果没有能力将“你忠实的学生”用作复数形式(或者可能将“你忠实的学生”或“你真实的学生”用作模棱两可的版本),那么列出多个作者会让人觉得尴尬和不自然(看起来像一封自然的人写的信是核心设计范例之一)

  • 如果考虑创建Java文档方法,那么还应该包括哪些其他特性?首先,约会似乎很常见。在信的顶部加上某种形式的日期注释可能看起来很自然,不会违背设计范式

  • 由于该语言是新的,大多数人都不熟悉,而且老实说,它相当愚蠢,因此这里有一些资源可供考虑:


    对不起,在我之前没有人关心这个问题! 我负责语言的发展,所以我想我已经很好地掌握了答案

  • 此类内部评论的要求是什么 文档有这种类型的吗 会导致问题的语法错误
  • 我从来没有考虑过像Javadoc这样的自动文档技术,所以没有正式的语法。我正在使用的编译器完全丢弃注释,因此它不支持它,但我相信这不会太难

  • 关键词是否足以适应主题?我想到了 那就是缺乏使用“你忠实的学生”的能力 复数形式(或者可能是“你的忠实”或“你的真实”,表示 模棱两可的版本)将使列出多个作者看起来很尴尬 和不自然的(看起来像一个自然的小马写的信是其中之一) 核心设计范例的一部分)
  • 最后一行的作者名字是为报告的第一作者设计的,因此在此之前从未建议过多个作者。然而,
    你忠实的学生,
    会很好地工作

  • 如果考虑创建Java文档方法,那么还有什么其他方法 应该包括哪些功能?首先,约会似乎很常见。包括…在内 在信的顶部写上某种形式的日期注释可能会 外观自然,不违背设计范式
  • 真的!也许是报告底部的一些东西,比如

    (Written 2013-04-11)
    

    希望这对你有帮助。你也有一些好主意!你应该加入这个团队

    谢谢你的回答!我很高兴能与团队中如此杰出的成员取得联系。我考虑过加入维基,但我想我有点害羞。我很高兴你认为我的想法有价值。哦,顺便说一句,在我投票给你之前,你的代表是1337。一个值得欣赏的里程碑。哈!令人惊叹的。但愿我能得到一张截图:P