How to Document Wisely

�l���͒Z���ĒN���ǂ܂Ȃ����炢�̂��Ƃ������Ă����B���Ȃ������킲�Ƃ������Ȃ��A�N���������ǂ܂Ȃ��ł��傤�B���������āA�����ǂ��h�L�������g���œK�ł��B�}�l�[�W���[�͂����𗝉����Ă��Ȃ����Ƃ��悭�����܂��B�Ȃ��Ȃ��A�������h�L�������e�[�V�����ł����Ă��A�ނ炪�v���O���}�[�Ɉˑ����Ă��Ȃ��Ƃ����������Z�L�����e�B���o���^���邩���ł��B�N�����{���ɖ��ɗ����Ȃ������������Ă����ƒf�����Ă����ꍇ�́A�u�͂��v�ƌ����ĐÂ��Ɏd�����T���n�߂��B

�h�L�������g�̎��v���ɘa���邽�߂ɁA�K�؂ȃh�L�������g�����ς����ɑg�ݍ��ނ̂ɂ����鎞�Ԃ𐳊m�Ɍ��ς��邱�Ƃ́A�����قnj��ʓI�ł͂����܂����B�^���͊����ē���F�e�X�g�̂悤�ȃh�L�������g�́A�R�[�h���J���������������{�����������邱�Ƃ������܂��B

�ǂ��������������Ƃ́A�܂������ɁA�ǂ��������ł��B���͂��Ȃ������M�A�׋��A���K�Ɋւ����{�����‚��邱�Ƃ������߂��܂��B�������A���Ƃ����Ȃ����ڗ��ȍ��Ƃł����Ă��A���Ȃ������������Ȃ����΂Ȃ��Ȃ����t�̕n���Ȗ��߂������Ă��Ă��A�����̃��[���͖{���ɕK�v�Ȃ��̂ł��F�u���Ȃ����ނ��ɂ��Ȃ��̂��Ƃ��������悤�ɁA���l�ɍs���܂��B�N�����Ȃ��̏��ނ��ǂ��ł����̂��A�������甲���o���K�v�������̂�??�A�ǂ̂悤�ɂ������������邱�Ƃ��ł����̂����l���Ă��������B���������Ȃ��A���Ȃ��͕��ϓI�ȃh�L�������e�[�V�������C�^�[�ł����A�ǂ��v���O���}�[�ɂȂ��ł��傤�B

�v���O���}�[�ȊO�̐l�����ۂɓǂނ��Ƃ��ł��镶�����쐬�����̂ł͂Ȃ��A���ۂɃR�[�h���̂𕶏������邱�ƂɊւ��ẮA�������܂łɒm���Ă����ō��̃v���O���}�[�͕��ՓI�Ȋ����������Ă��܂��F�����̃R�[�h�������āA�R�[�h���̂��������Ƃł͂����肳���邱�Ƃ͂ł��܂����B�����ɂ́A2�‚̗��R�������܂��B�܂��A�R�[�h���x���̃h�L�������g���Q�Ƃ����K�v�������l�́A�قƂ��ǂ̏ꍇ�A�R�[�h���ǂ߂��悤�ɂȂ��܂��B�m���ɁA�����͏��S�҂������o���L�x�ȃv���O���}�[�ɂƂ��Ă͊ȒP�ł��B�������A�����ɏd�v�Ȃ̂́A�������Ȃ����΁A�R�[�h�ƕ����͖������Ă��Ȃ��Ƃ������Ƃł��B�ň��̏ꍇ�A�\�[�X�R�[�h�͊Ԉ����č��������”\���������܂��B���S�ɏ������Ă��Ȃ����΁A���̕����͂������‚����Ƃ��ł��A�����͉����{���������܂��B

�����͐ӔC�����v���O���}�[�ɂƂ��Ă����ȒP�ɂ͂Ȃ��܂����B�����̃R�[�h���ǂ̂悤�ɏ����̂ł����H�����͂ǂ������Ӗ��ł����H���̈Ӗ��́F

�N�����������ǂޕK�v�����邱�Ƃ��m���Ă����R�[�h�������B

  • �S�[���f�����[�����K�p�����B
  • �ʂ̃\�����[�V�������v���ɗ��p�ł����ꍇ�ł��A�ȒP�ȃ\�����[�V�������I�������B
  • �R�[�h�����lj����鏬���ȍœK�����]���ɂ����B
  • �ǎ҂̂��Ƃ��l���āA�ޏ��������Ɗy�ɂ����M�d�Ȏ��Ԃ����₵�Ă��������B������
  • foo�Abar�A doIt�̂悤�Ȋ֐������g�p���邱�Ƃ͂����܂����I

Next How to Work with Poor Code

results matching ""

    No results matching ""