Repository navigation
/** */ Style comments in code examples don't convert correctly #64961
Description
🔎 Search Terms
I'm trying to put a code example in a JavaDoc comment. However, the escaped characters show up as escape characters instead of the regular characters I'm trying to display. For example;
/**
* \/** comment in comment *\/
*/
Turns into
\/** comment in comment *\/
But should turn into;
/** comment in comment */
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about javadocs.
⏯ Playground Link
No response
💻 Code
The input code
/**
* @see {@link I_Trial}
* An API trial is a trial that should be used to test an API (expanded as an Application Programming Interface ).
* This could be an internal interface of a program, a public command-line interface between programs, or a RESTful or other web-based interface.
* In other words, this kind of trial is the catch-all when nother trial type does not seem appropriate for your tests use an ApiTrial.
* For example;
*
* ```
* import { I_Class} from '@ts.adligo.org/i_obj/dist/i_obj.mjs';
* import { I_AssertionContext } from '@ts.adligo.org/i_tests4ts/dist/i_assertions.mjs';
* import { I_Trial } from '@ts.adligo.org/i_tests4ts/dist/i_tests4ts.mjs';
* import { ApiTrial} from '@ts.adligo.org/tests4ts/dist/trials.mjs';
*
* export class FooApiTrial extends ApiTrial {
* public static readonly CLASS_NAME = 'FooApiTrial';
* public static readonly CLAZZ_NAME = PROC_TESTS_PACKAGE_DOT + FooApiTrial.CLASS_NAME;
*
*
* \/** \@see {\@link I_Class}
* * Also note this fulll package and class name allows (Hudson, Jenkins) or Travis CI (continuous integration) tools
* * the ability to group Trials and their tests by package and class name. Hudson, Jenkins and Travis all have
* * great JUnit results charts and drill down interfaces that tests4ts is integrated with.
* *\/
* getClass(): string { return FooApiTrial.CLAZZ_NAME; }
*
* testSomethingCool(ac: I_AssertionContext) {
* ac.isTrue(false);
* }
* }
* ```
*
* Note the example is copy and pasteable from the VSCode hover over (intellisence) javadoc popup.
*/The expected output (intellisence popup in VS Code);
import { I_Class} from '@ts.adligo.org/i_obj/dist/i_obj.mjs';
import { I_AssertionContext } from '@ts.adligo.org/i_tests4ts/dist/i_assertions.mjs';
import { I_Trial } from '@ts.adligo.org/i_tests4ts/dist/i_tests4ts.mjs';
import { ApiTrial} from '@ts.adligo.org/tests4ts/dist/trials.mjs';
export class FooApiTrial extends ApiTrial {
public static readonly CLASS_NAME = 'FooApiTrial';
public static readonly CLAZZ_NAME = PROC_TESTS_PACKAGE_DOT + FooApiTrial.CLASS_NAME;
/** @see {@link I_Class}
* Also note this fulll package and class name allows (Hudson, Jenkins) or Travis CI (continuous integration) tools
* the ability to group Trials and their tests by package and class name. Hudson, Jenkins and Travis all have
* great JUnit results charts and drill down interfaces that tests4ts is integrated with.
*/
getClass(): string { return FooApiTrial.CLAZZ_NAME; }
testSomethingCool(ac: I_AssertionContext) {
ac.isTrue(false);
}
}🙁 Actual behavior
The current output (intellisence popup in VS Code);
import { I_Class} from '@ts.adligo.org/i_obj/dist/i_obj.mjs';
import { I_AssertionContext } from '@ts.adligo.org/i_tests4ts/dist/i_assertions.mjs';
import { I_Trial } from '@ts.adligo.org/i_tests4ts/dist/i_tests4ts.mjs';
import { ApiTrial} from '@ts.adligo.org/tests4ts/dist/trials.mjs';
export class FooApiTrial extends ApiTrial {
public static readonly CLASS_NAME = 'FooApiTrial';
public static readonly CLAZZ_NAME = PROC_TESTS_PACKAGE_DOT + FooApiTrial.CLASS_NAME;
\/** \@see {\@link I_Class}
* Also note this fulll package and class name allows (Hudson, Jenkins) or Travis CI (continuous integration) tools
* the ability to group Trials and their tests by package and class name. Hudson, Jenkins and Travis all have
* great JUnit results charts and drill down interfaces that tests4ts is integrated with.
*\/
getClass(): string { return FooApiTrial.CLAZZ_NAME; }
testSomethingCool(ac: I_AssertionContext) {
ac.isTrue(false);
}
}🙂 Expected behavior
I don't expect to see the escape characters in the JavaDoc pop-up menu, i.e. I'm seeing '/' or '@' and want to see '/' or '@' respectively.
Additional information about the issue
No response
Activity