Comment
Stores a free-text author comment that can be attached to any localization target.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Class
- Namespace: Unity.Localization
- Assembly: UnityEngine.LocalizationRuntimeModule
- Implements: IMetadata
public class Comment : IMetadata
Remarks
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
Attach a comment to a metadata collection.
Examples
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
Property | Description |
|---|---|
| CommentText | The comment text. |