CodeDocAnnotator

Generate markup documentation annotations

LLMResourceFunction["CodeDocAnnotator"][lang,code]

generates documentation for the code of the programming language lang.

LLMResourceFunction["CodeDocAnnotator"][lang]

gives a generic prompt for documentation generation for lang.

Details

For Wolfram Language the function prompt generates usage information and syntax information code.

Here is a list of the programming languages known by the prompt:

C, C#, C++, Clojure, D, Elixir, F#, Fortran, Go, Haskell, Java, JavaScript, Kotlin, Mathematica, OCaml, Perl, PHP, Python, R, Raku, Ruby, Rust, Scala, Swift, TypeScript, VB.NET, WL, Wolfram Language

Programmatic Examples

Put documentation comments into Wolfram Language code:

In[1]:=

code="FullZIPCode[x_Integer]:=Block[{x2=ToString[x]},If[StringLength[x2]<5,StringJoin[Table[\"0\",5-StringLength[x2]]]<>x2,x2]];FullZIPCode[x_String]:=x;";LLMSynthesize[{LLMPrompt["CodeDocAnnotator"]["Wolfram Language",code],LLMPrompt["NothingElse"]["Wolfram Language"]}]

Out[1]=

```wolframFullZIPCode::usage = "FullZIPCode[x] takes an integer x and returns a string representing a full ZIP code, padded with leading zeros if necessary. If x is already a string, it simply returns the string.";FullZIPCode::syntax = "FullZIPCode[x_Integer] or FullZIPCode[x_String]";FullZIPCode[x_Integer]:= Block[{x2=ToString[x]}, If[StringLength[x2]<5,StringJoin[Table["0",5-StringLength[x2]]]<>x2,x2] ];FullZIPCode[x_String]:=x;```

Scope
(2)

Make Javadoc strings for Java code:

In[1]:=

code="public class Greeting { private String message; public Greeting(String initialMessage) { this.message = initialMessage; } public void displayMessage() { System.out.println(message); } public static void main(String[] args) { Greeting helloGreeting = new Greeting(\"Hello, Java!\"); helloGreeting.displayMessage(); Greeting welcomeGreeting = new Greeting(\"Welcome to the world of classes!\"); welcomeGreeting.displayMessage(); }}";LLMSynthesize@LLMPrompt["CodeDocAnnotator"]["Java",code]

Out[1]=

```javapublic class Greeting { private String message; /** * Constructs a Greeting object with the specified initial message. * * @param initialMessage the message to be set for this Greeting */ public Greeting(String initialMessage) { this.message = initialMessage; } /** * Displays the current greeting message to the standard output. */ public void displayMessage() { System.out.println(message); } /** * The main method demonstrates the usage of the Greeting class by * creating instances and displaying their messages. * * @param args command-line arguments (not used) */ public static void main(String[] args) { Greeting helloGreeting = new Greeting("Hello, Java!"); helloGreeting.displayMessage(); Greeting welcomeGreeting = new Greeting("Welcome to the world of classes!"); welcomeGreeting.displayMessage(); }}```

Create a prompt to be used with code strings:

In[2]:=

LLMPrompt["CodeDocAnnotator"]["Wolfram Language"]

Out[2]=

You are an expert Wolfram Language programmer and a good writer of technical documentation.For the given Wolfram Language code below preface every function or class method with corresponding `Information` "::usage" message and `SyntaxInformation` spec for the syntax coloring of the corresponding input lines.Keep the user comments.The documentation comments you generate are both concise and descriptive.CODE:

Wolfram Prompt Repository(Under Construction)

CodeDocAnnotator

Details

Programmatic Examples

Scope
(2)

Neat Examples
(1)



External Links

Prompt Source

See Also

Publisher Information

CodeDocAnnotator

Details

Programmatic Examples

Scope (2)

Neat Examples (1) 

External Links

Prompt Source

See Also

Publisher Information

Scope
(2)

Neat Examples
(1)

