���W�F�c�[�����g�����h�L�������g�쐬�Z�@�i�O�ҁj

���l�̂���J���h�L�������g�������I�ɍ쐬����ɂ́H

�A�o�i�[�h��������@�s�� �����iMicrosoft MVP 2008 for XML�j
2008/05/20
Page1 Page2 Page3

��XML�h�L�������g�E�R�����g���L�q�����\�[�X�E�R�[�h�̍쐬

�@�܂���Visual Studio 2008��Visual Studio 2005�ŃR���\�[���E�A�v���P�[�V������V�K�쐬���i�v���W�F�N�g�̖��O�́uSandCastleSample�v�Ƃ���j�A�T���v���E�v���O�����Ƃ��Ĉȉ��̃R�[�h���L�q����B

using System;

namespace SandCastleSample
{
  /// <summary>
  /// �G���g���E�|�C���g�E�N���X
  /// </summary>
  class Program
  {
    /// <summary>
    /// ���C���E�G���g���E�|�C���g
    /// </summary>
    /// <param name="args">�R�}���h���C�������z��</param>
    static void Main(string[] args)
    {
      SampleClass sample = new SampleClass();
      sample.ShowMessage(
        "�T���v�����Y", "�h�L�������g�͑厖�ł���B");
    }
  }

  /// <summary>
  /// �T���v���N���X
  /// </summary>
  public class SampleClass
  {
    /// <summary>
    /// ���b�Z�[�W��\������
    /// </summary>
    /// <param name="name">���b�Z�[�W�̑Ώێ�</param>
    /// <param name="message">���b�Z�[�W�̖{��</param>
    public void ShowMessage(string name, string message)
    {
      Console.WriteLine(
        string.Format("{0}����փ��b�Z�[�W�ł��B", name));
      Console.WriteLine(string.Format("{0}", message));
      Console.ReadLine();
    }
  }

}
''' <summary>
''' �G���g���E�|�C���g�E���W���[��
''' </summary>
Module Program
  ''' <summary>
  ''' ���C���E�G���g���E�|�C���g
  ''' </summary>
  ''' <param name="args">�R�}���h���C�������z��</param>
  Sub Main(ByVal args() As String)
    Dim sample As New SampleClass()
    sample.ShowMessage( _
      "�T���v�����Y", "�h�L�������g�͑厖�ł���B")
  End Sub
End Module

''' <summary>
''' �T���v���N���X
''' </summary>
Public Class SampleClass
  ''' <summary>
  ''' ���b�Z�[�W��\������
  ''' </summary>
  ''' <param name="name">���b�Z�[�W�̑Ώێ�</param>
  ''' <param name="message">���b�Z�[�W�̖{��</param>
  Public Sub ShowMessage(ByVal name As String, ByVal message As String)
    Console.WriteLine( _
      String.Format("{0}����փ��b�Z�[�W�ł��B", name))
    Console.WriteLine(String.Format("{0}", message))
    Console.ReadLine()
  End Sub
End Class
�R���\�[����ʂɃ��b�Z�[�W��\������T���v���E�v���O�����i��FC#�A���FVB�j

�@���̃R�[�h�ł́u<summary>�v�Ȃǂ̃^�O���g����XML�h�L�������g�E�R�����g���L�q����Ă���BVisual Studio�̃R�[�h�E�G�f�B�^�ł́AC#�ł́u///�v�AVB�ł́u'''�v�̂悤�ɃR�����g�L����3�‘����ċL�q���邱�ƂŁA�u<summary>�v�Ȃǂ�XML�h�L�������g�E�R�����g�������}���ł���BXML�h�L�������g�E�R�����g�̃^�O�́AIntelliSense��������͂ł���B�Ȃ��AVB�ł�XML�h�L�������g�E�R�����g�ɑΉ����Ă���o�[�W�����́AVisual Studio 2005�ȍ~�Ȃ̂Œ��ӂ��Ăق����B

��XML�h�L�������g�E�R�����g�̃^�O�ꗗ

�@�Q�l�܂łɁAXML�h�L�������g�E�R�����g�̎�v�ȃ^�O�ɂ‚��ĊȒP�ɂ܂Ƃ߂��B

�^�O ����
<summary> �u�T�v�v���L�q����
�p�@�F<summary>�T�v</summary>
<remarks> �u����v���L�q����
�p�@�F<remarks>���</remarks>
<param> name�����Ƀ��\�b�h�́u�i1�‚́j�p�����[�^�̖��O�v���w�肵�āA���̃p�����[�^�́u�����v���L�q����
�p�@�F<param name="�p�����[�^�̖��O">����</param>
<typeparam> name�����ɃW�F�l���b�N�^��W�F�l���b�N�E���\�b�h�́u�^�p�����[�^�̖��O�v���w�肵�āA���̌^�p�����[�^�́u�����v���L�q����
�p�@�F<typeparam name="�^�p�����[�^�̖��O">����</typeparam>
<returns> ���\�b�h�́u�߂�l�̐����v���L�q����
�p�@�F<returns>�߂�l�̐���</returns>
<value> �u�v���p�e�B�̐����v���L�q����
�p�@�F<value>�v���p�e�B�̐���</value>
<example> �u�T���v���E�R�[�h�v���L�q����
�p�@�F<example>�T���v���E�R�[�h</example>
<exception> cref�����Ɂu��O�N���X�̖��O�v���w�肵�āA���̗�O�́u�����v���L�q����B��O�N���X�̖��O�́A�Ⴆ�΁uSystem.OverflowException�v�Ȃǂ̂悤�ɖ��O��Ԃ�t�������O
�p�@�F<exception cref="��O�N���X�̖��O">����</exception>
XML�h�L�������g�E�R�����g�̃^�O�ꗗ
���Ȃ݂�XML�h�L�������g�E�R�����g�̃e�L�X�g���Ɂu<�v��u>�v���L�q�������Ƃ��́AHTML�R�[�h�Ɠ����悤�Ɂu&lt;�v��u&gt;�v���g�p����B

�@���̂ق��A<summary>�^�O�A<remarks>�^�O�A<returns>�^�O�Ȃǂň͂񂾃e�L�X�g�̒��Ŏg�p�ł���u�����w��^�O�v���p�ӂ���Ă���B����ɂ‚��Ă����̕\�ɊȒP�ɂ܂Ƃ߂����A�p�@�ɂ‚��Ă�MSDN�iC#�AVB�j���Q�Ƃ��Ăق����B

�����w��^�O ����
<para> �u�i���v�����
<list> ��������ԍ��t���́u���X�g�v�����
<paramref> �u�p�����[�^�ւ̎Q�Ɓv�����
<typeparamref> �u�^�p�����[�^�ւ̎Q�Ɓv�����
<c> �ꕔ���̃e�L�X�g���u�R�[�h�\�L�v�ɂ���
<seealso> �u�N���X�⃁���o�ւ̎Q�Ɓv�i�Z�N�V�����j���쐬����
<see> �N���X�⃁���o�ւ́u�e�L�X�g�E�����N�v���쐬����
XML�h�L�������g�E�R�����g�́u�����w��^�O�v�ꗗ
�����̃^�O��<summary>�^�O�A<remarks>�^�O�A<returns>�^�O�ň͂񂾃e�L�X�g�̒��Ŏg�p�ł���B
���̂ق��ɁA<example>�^�O�ň͂񂾃e�L�X�g�̒��Ŏg�p�ł���u<code>�^�O�v������B�����<c>�^�O�Ɠ����悤�ɁA�ꕔ���̃e�L�X�g���u�R�[�h�\�L�v�ɂ���B

��XML�h�L�������g�E�t�@�C���̐���

�@�����ām�\�����[�V���� �G�N�X�v���[���n�̃v���W�F�N�g���ځi�����ł́uSandCastleSample�v�j���E�N���b�N���āA�\�������R���e�L�X�g�E���j���[����m�v���p�e�B�n��I�����A�v���W�F�N�g�E�v���p�e�B�̐ݒ��ʂ�\������B

�@C#�ł́m�r���h�n�^�u���J���A�mXML �h�L�������g �t�@�C���n�`�F�b�N�{�b�N�X�Ƀ`�F�b�N������iVB�ł́m�R���p�C���n�^�u���J���A�mXML �h�L�������g �t�@�C���𐶐�����n�`�F�b�N�{�b�N�X�Ƀ`�F�b�N������j�B

SandCastleSample�v���W�F�N�g�̃v���p�e�B�ݒ��ʁiC#�j
XML�h�L�������g�E�t�@�C���𐶐�����I�v�V������ݒ肷��B
  XML�h�L�������g�E�t�@�C���ɏo�͐�p�X���w�肷��B

�@�Ō�Ƀv���W�F�N�g���r���h����΁A�T���v���E�A�v���P�[�V�����̎��s�`���t�@�C���iSandCastleSample.exe�j�Ɠ����t�H���_��SandCastleSample.XML�t�@�C������������Ă���͂��ł���B

�@�ȏ�Ń\�[�X�E�R�[�h���̏����͊��������̂ŁA���Ƃ͎��ۂ�Sandcastle���g�p����CHM�`���t�@�C���𐶐����Ă������B���̍ۂɁASandcastle Help File Builder���g�p����ƍ�Ƃ��y�ɂȂ�B

��Sandcastle Help File Builder�̎g����

�@Sandcastle Help File Builder���g�p����ɂ́A�m�X�^�[�g�n���j���[����m���ׂẴv���O�����n�|�mSandcastle Help File Builder�n�|�mSandcastle Help File Builder GUI�n��I�����ASandcastle Help File Builder���N������B

Sandcastle Help File Builder�̉��
�܂��mProject Properties�n�̊e�p�����[�^��ݒ肷��B���̗�ł́mLanguage�n�v���p�e�B�Ɂu���{��i���{�j�v��ݒ肵�Ă���B

�@�mProject Properties�n�̊e�p�����[�^��ݒ肷�邱�ƂŁA�Ⴆ�Όp�����̃N���X�̃����o�ɂ‚��Ă͏o�͑ΏۊO�ɂ�����A�p�u���b�N�ȃ����o�݂̂��o�͑Ώۂɂ�����Ƃ������ׂ����ݒ肪�ł���悤�ɂȂ��Ă���B�p�����[�^�̐ݒ肪�I�������mAdd�n�{�^���������A�T���v���E�A�v���P�[�V�����̎��s�`���t�@�C���i�����ł͐�قǐ��������uSandCastleSample.exe�v�j���w�肷��B�Ō�ɁA���j���[�E�o�[����mDocumentation�n�|�mBuild Project�n��I������΁ACHM�`���t�@�C������������A��Ƃ͊����ł���B

�@�������ꂽCHM�`���t�@�C�����m�F�������ꍇ�́A���j���[�E�o�[����mDocumentation�n�|�mView Help File�n�|�mView Help File�n��I������΁A�ȒP�Ɋm�F�ł���B�ȉ��ɃT���v���E�v���O�������玩���������ꂽCHM�`���t�@�C���̗�������B

�����������ꂽCHM�`���t�@�C��
CHM�`���t�@�C�����m�F����ɂ́A���j���[�E�o�[����mDocumentation�n�|�mView Help File�n�|�mView Help File�n��I������΂悢�B
  ����^�u��؂�ւ��邱�ƂŊe����ɉ������V���^�b�N�X��`�ɐ؂�ւ��邱�Ƃ��ł���B

�@���̂悤�Ƀ\�[�X�E�R�[�h��Ɍ��߂�ꂽ������XML�h�L�������g�E�R�����g���L�q���Ă����΁ASandcastle���g�p����CHM�`���̃h�L�������g���ȒP�Ɏ��������ł���̂ł���B�O�q�����u�J�����ɍ쐬�����h�L�������g�ꗗ�v�̒��ɃN���X�݌v�������邪�A���ۂ̋Ɩ��V�X�e���ł̓N���X�̐���3�����ɋy�Ԃ��Ƃ�����B�����N���X�̒�`���������������Ă��Ă͔��ɍH�����������Ă��܂��B�����������ꍇ��Sandcastle���g�p����΁A���̍H���𐏕��ƍ팸�ł��邾�낤�B

��

�@����́A���l�̂���h�L�������g���������߂̃R�c�ƁA�����I�Ƀh�L�������g���쐬����c�[���Ƃ���Sandcastle���Љ���B��҂ł́ASandcastle�ƁA����1�‚̕ʂ̃c�[���ł���GhostDoc��g�ݍ��킹���h�L�������g�쐬�Z�@��Apatterns & practices Documentation Tools�ɂ‚��ďЉ��\��ł���BEnd of Article


�@INDEX
�@ [���W]
�@ �c�[�����g�����h�L�������g�쐬�Z�@�i�O�ҁj
�@ ���l�̂���J���h�L�������g�������I�ɍ쐬����ɂ́H
�@   1. �A�W���C���E�h�L�������g�Ƃ͉����H
�@   2. ���l�̂���h�L�������g���쐬����R�c
  3. �c�[�����g�����h�L�������g�̍쐬�Z�@
�@
�@ �c�[�����g�����h�L�������g�쐬�Z�@�i��ҁj
�@ �}�C�N���\�t�g�����{���Ă���h�L�������g�쐬�Z�@
�@   1. �_���XML�h�L�������g�E�R�����g�𐶐�����uGhostDoc�v
�@   2. GhostDoc��SandCastle��g�ݍ��킹���h�L�������g�쐬�Z�@
�@   3. �}�C�N���\�t�g�����p����upatterns & practices Documentation Tools�v


Insider.NET �t�H�[���� �V���L��
  • ��2��@�Ȍ��ȃR�[�f�B���O�̂��߂� �i2017/7/26�j
    �@�����_���ŋL�q�ł��郁���o�̑����Athrow���Aout�ϐ��A�^�v���ȂǁAC# 7�ɂ͈ȑO�����R�[�h���Ȍ��ɋL�q�ł���悤�ȋ@�\����������Ă���
  • ��1��@Visual Studio Code�f�o�b�O�̊�b�m�� �i2017/7/21�j
    �@Node.js�v���O�������f�o�b�O���Ȃ���AVisual Studio Code�ɓ�������Ă���f�o�b�O�@�\�̊�{�́u�L�v���}�X�^�[���悤
  • ��1��@���ĂȃR�[�f�B���O�̂��߂� �i2017/7/19�j
    �@C# 7�Œlj����ꂽ�V�@�\�̒�����A�u���l���e�����\���̉��P�v�Ɓu���[�J���֐��v���Љ��B�����͕�����₷���R�[�h���L�q����̂Ɏg����
  • Presentation Translator �i2017/7/18�j
    �@Presentation Translator��PowerPoint�p�̃A�h�C���B�v���[���e�[�V�������̎����̕t����A������ł̎��^�����A�X���C�h�̖|����s����
��IT���[���}�K�W���@�V������X�^�b�t�̃R���������[���œ͂��܂��i�����j

���ڂ̃e�[�}

Insider.NET �L�������L���O

�{�� ����