RFR: 8273544: Increase test coverage for snippets [v2]
Pavel Rappo
prappo at openjdk.java.net
Thu Nov 18 11:44:41 UTC 2021
On Thu, 18 Nov 2021 10:57:34 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:
>> Pavel Rappo has updated the pull request incrementally with one additional commit since the last revision:
>>
>> Test one more corner case example
>
> test/langtools/jdk/javadoc/doclet/testSnippetTag/TestSnippetTag.java line 71:
>
>> 69: * 3. ("Inline", "External", "Hybrid")
>> 70: * 4. ("Tag", "Markup")
>> 71: * 5. <custom string>
>
> I assume the purpose of this naming scheme is to make visible what combinations of features are covered by each test. I'm not sure I would consider this enough benefit to justify method names which are very verbose and hard to read (especially when you don't have fresh memory of the scheme above).
When one is planning to have many methods, one should better have a plan for how to maintain them. Such a plan should cover navigation, search, and if growth is foreseen, naming new methods. A naming scheme could in itself be such a plan.
I've tried alternative naming schemes but found this one to work best. It's obviously possible that I missed something. If you have other ideas, please share and let's discuss them.
-------------
PR: https://git.openjdk.java.net/jdk/pull/6359
More information about the javadoc-dev
mailing list