Re: Adding VB code snippets in help documentation

Tech-Archive recommends: Repair Windows Errors & Optimize Windows Performance

On Oct 10, 11:06 am, "Peter Foot [MVP]" <feedb...@nospam-
inthehand.com> wrote:
The <code> tag was devised originally for C# comments and no capability was
added to it to specify the code language. Therefore the documentation
compiler is probably just making a best guess and assuming it's C#. Ideally
the spec should be updated to include an attribute to specify the code type
and help file generators could use this to correctly display the snippet
e.g.
<code language="C#"> etc

Some help file generators allow you to extend them to support custom xml
tags in which case you could add a <codevb> tag and then define how this is
integrated into the help file.

Peter

--
Peter Foot
Microsoft Device Application Development MVP
peterfoot.net | appamundi.com | inthehand.com
APPA Mundi Ltd - software solutions for a mobile world
In The Hand Ltd - .NET Components for Mobility

"Jothishankar" <shanka...@xxxxxxxxx> wrote in message

news:6f2475c4-9287-478d-84b4-d67c99028dd9@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
On Oct 9, 7:08 pm, Kevin Matthews





<KevinMatth...@xxxxxxxxxxxxxxxxxxxxxxxxx> wrote:
vb documentation uses three single quotes instead of slashes for it's
notation. This might be the issue.

''' <summary></summary>

"Jothishankar" wrote:
Hi,

I am creating a C# class library. I want to add C# and VB code
snippets along with the code documentation, so that these snippets
appear as examples when help file is generated (I use Docuemnt! X help
file generator). I am using the following tag structure in the source
code to add the documentation.

/// <summary>
.....
/// </summary>
/// <example>
/// <code>
.......
/// </code>
/// </example>

But the issue is, whatever code (C# or VB) I give inside the <code></
code> tag, appears as only a C# Example section in the final help
file. How can I create a VB Example section?

Thanks in advance.

- Jothishankar

Thanks for the reply Kevin. I am inserting these tags in a C#
solution. So I have to use ///. But I am trying to insert a VB code
snippet inside the <code> tag (Just like in MSDN, where both C# and VB
example code snippets are provided). The final help file generated by
Document!X seems to show both the C# and VB code snippets as C#
examples.- Hide quoted text -

- Show quoted text -

I tried using <code lang="VB"> and it worked. But strange thing is
that the 'lang' attribute for the code tag was not documented anywhere
nor was it visible in Intellisense. Anyway, thanks for your help Peter.
.

Relevant Pages

  • Re: Adding VB code snippets in help documentation
    ... Therefore the documentation compiler is probably just making a best guess and assuming it's C#. Ideally the spec should be updated to include an attribute to specify the code type and help file generators could use this to correctly display the snippet e.g. ... Some help file generators allow you to extend them to support custom xml tags in which case you could add a tag and then define how this is integrated into the help file. ... > snippets along with the code documentation, ...
    (microsoft.public.dotnet.framework.compactframework)
  • Re: Adding VB code snippets in help documentation
    ... snippets along with the code documentation, ... appear as examples when help file is generated (I use Docuemnt! ... I am using the following tag structure in the source ...
    (microsoft.public.dotnet.framework.compactframework)
  • Re: SWX Documentation-Matt Lombard Nails It
    ... the lack of documentation on the software that we ... We have 15 seats of SWX plus a few seats of Cosmos ... Solidworks Bible from Matt. ... If SolidWorks wants to really let the help file be usable particularly ...
    (comp.cad.solidworks)
  • Re: copy files...????
    ... The first place you look for any API function should be MSDN, ... Delphi comes with a help file that describes a large portion of the API, ... If you have lots of time, you can download the MSDN documentation. ...
    (borland.public.delphi.ide)
  • Documentation and adding users
    ... For Documentation I would recommend the Admin Guide and ... Then you manage all users in Active Directory. ... help file, or of some ...
    (microsoft.public.sharepoint.windowsservices)