Comment

Description

Stores a free-text author comment that can be attached to any localization target.

A comment can hold any information, but it is most useful for giving translators context about an entry. It implements IMetadata, so it is stored in a MetadataCollection. The MetadataAttribute on this type allows it on every target and limits each target to a single comment.

Additional resources: IMetadata, MetadataCollection, MetadataAttribute, ExcludeEntryFromEditorExport

<para>Attach a comment to a metadata collection.</para>

using Unity.Localization;

namespace Unity.Localization.Samples
{
    public class CommentExample
    {
        public void Run(MetadataCollection metadata)
        {
            metadata.AddMetadata(new Comment { CommentText = "Keep under 20 characters." });
        }
    }
}

Properties